Adobe Commerce GraphQL API

The Adobe Commerce GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your storefront. The schema documented here is autogenerated from an instance of Adobe Commerce with B2B. You can find examples of each query and mutation in the main GraphQL documentation.

API Endpoints
https://<your store>/graphql
Version

2.4.7-beta

Queries

availableStores

Description

(BETA) Get a list of available store views and their config information.

Response

Returns [StoreConfig]

Arguments
Name Description
useCurrentGroup - Boolean (BETA) Filter store views by the current store group.

Example

Query
query availableStores($useCurrentGroup: Boolean) {
  availableStores(useCurrentGroup: $useCurrentGroup) {
    absolute_footer
    allow_gift_receipt
    allow_gift_wrapping_on_order
    allow_gift_wrapping_on_order_items
    allow_guests_to_write_product_reviews
    allow_items
    allow_order
    allow_printed_card
    autocomplete_on_storefront
    base_currency_code
    base_link_url
    base_media_url
    base_static_url
    base_url
    braintree_cc_vault_active
    cart_gift_wrapping
    cart_printed_card
    catalog_default_sort_by
    category_fixed_product_tax_display_setting
    category_url_suffix
    check_money_order_enable_for_specific_countries
    check_money_order_enabled
    check_money_order_make_check_payable_to
    check_money_order_max_order_total
    check_money_order_min_order_total
    check_money_order_new_order_status
    check_money_order_payment_from_specific_countries
    check_money_order_send_check_to
    check_money_order_sort_order
    check_money_order_title
    cms_home_page
    cms_no_cookies
    cms_no_route
    code
    configurable_thumbnail_source
    copyright
    default_description
    default_display_currency_code
    default_keywords
    default_title
    demonotice
    enable_multiple_wishlists
    front
    grid_per_page
    grid_per_page_values
    head_includes
    head_shortcut_icon
    header_logo_src
    id
    is_default_store
    is_default_store_group
    is_negotiable_quote_active
    is_requisition_list_active
    list_mode
    list_per_page
    list_per_page_values
    locale
    logo_alt
    logo_height
    logo_width
    magento_reward_general_is_enabled
    magento_reward_general_is_enabled_on_front
    magento_reward_general_min_points_balance
    magento_reward_general_publish_history
    magento_reward_points_invitation_customer
    magento_reward_points_invitation_customer_limit
    magento_reward_points_invitation_order
    magento_reward_points_invitation_order_limit
    magento_reward_points_newsletter
    magento_reward_points_order
    magento_reward_points_register
    magento_reward_points_review
    magento_reward_points_review_limit
    magento_wishlist_general_is_enabled
    maximum_number_of_wishlists
    minimum_password_length
    no_route
    payment_payflowpro_cc_vault_active
    printed_card_price
    product_fixed_product_tax_display_setting
    product_reviews_enabled
    product_url_suffix
    required_character_classes_number
    returns_enabled
    root_category_id
    root_category_uid
    sales_fixed_product_tax_display_setting
    sales_gift_wrapping
    sales_printed_card
    secure_base_link_url
    secure_base_media_url
    secure_base_static_url
    secure_base_url
    send_friend {
      ...SendFriendConfigurationFragment
    }
    show_cms_breadcrumbs
    store_code
    store_group_code
    store_group_name
    store_name
    store_sort_order
    timezone
    title_prefix
    title_separator
    title_suffix
    use_store_in_url
    website_code
    website_id
    website_name
    weight_unit
    welcome
    zero_subtotal_enable_for_specific_countries
    zero_subtotal_enabled
    zero_subtotal_new_order_status
    zero_subtotal_payment_action
    zero_subtotal_payment_from_specific_countries
    zero_subtotal_sort_order
    zero_subtotal_title
  }
}
Variables
{"useCurrentGroup": false}
Response
{
  "data": {
    "availableStores": [
      {
        "absolute_footer": "abc123",
        "allow_gift_receipt": "xyz789",
        "allow_gift_wrapping_on_order": "abc123",
        "allow_gift_wrapping_on_order_items": "xyz789",
        "allow_guests_to_write_product_reviews": "xyz789",
        "allow_items": "xyz789",
        "allow_order": "xyz789",
        "allow_printed_card": "abc123",
        "autocomplete_on_storefront": true,
        "base_currency_code": "abc123",
        "base_link_url": "xyz789",
        "base_media_url": "abc123",
        "base_static_url": "abc123",
        "base_url": "xyz789",
        "braintree_cc_vault_active": "abc123",
        "cart_gift_wrapping": "xyz789",
        "cart_printed_card": "xyz789",
        "catalog_default_sort_by": "abc123",
        "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
        "category_url_suffix": "abc123",
        "check_money_order_enable_for_specific_countries": true,
        "check_money_order_enabled": true,
        "check_money_order_make_check_payable_to": "xyz789",
        "check_money_order_max_order_total": "xyz789",
        "check_money_order_min_order_total": "xyz789",
        "check_money_order_new_order_status": "abc123",
        "check_money_order_payment_from_specific_countries": "abc123",
        "check_money_order_send_check_to": "abc123",
        "check_money_order_sort_order": 987,
        "check_money_order_title": "abc123",
        "cms_home_page": "xyz789",
        "cms_no_cookies": "xyz789",
        "cms_no_route": "abc123",
        "code": "abc123",
        "configurable_thumbnail_source": "abc123",
        "copyright": "abc123",
        "default_description": "xyz789",
        "default_display_currency_code": "xyz789",
        "default_keywords": "abc123",
        "default_title": "xyz789",
        "demonotice": 987,
        "enable_multiple_wishlists": "abc123",
        "front": "abc123",
        "grid_per_page": 987,
        "grid_per_page_values": "abc123",
        "head_includes": "xyz789",
        "head_shortcut_icon": "xyz789",
        "header_logo_src": "abc123",
        "id": 123,
        "is_default_store": false,
        "is_default_store_group": false,
        "is_negotiable_quote_active": true,
        "is_requisition_list_active": "abc123",
        "list_mode": "abc123",
        "list_per_page": 987,
        "list_per_page_values": "abc123",
        "locale": "xyz789",
        "logo_alt": "abc123",
        "logo_height": 123,
        "logo_width": 987,
        "magento_reward_general_is_enabled": "abc123",
        "magento_reward_general_is_enabled_on_front": "abc123",
        "magento_reward_general_min_points_balance": "abc123",
        "magento_reward_general_publish_history": "xyz789",
        "magento_reward_points_invitation_customer": "xyz789",
        "magento_reward_points_invitation_customer_limit": "xyz789",
        "magento_reward_points_invitation_order": "xyz789",
        "magento_reward_points_invitation_order_limit": "abc123",
        "magento_reward_points_newsletter": "xyz789",
        "magento_reward_points_order": "abc123",
        "magento_reward_points_register": "abc123",
        "magento_reward_points_review": "xyz789",
        "magento_reward_points_review_limit": "xyz789",
        "magento_wishlist_general_is_enabled": "abc123",
        "maximum_number_of_wishlists": "xyz789",
        "minimum_password_length": "xyz789",
        "no_route": "abc123",
        "payment_payflowpro_cc_vault_active": "abc123",
        "printed_card_price": "abc123",
        "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
        "product_reviews_enabled": "xyz789",
        "product_url_suffix": "abc123",
        "required_character_classes_number": "xyz789",
        "returns_enabled": "xyz789",
        "root_category_id": 987,
        "root_category_uid": "4",
        "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
        "sales_gift_wrapping": "xyz789",
        "sales_printed_card": "abc123",
        "secure_base_link_url": "abc123",
        "secure_base_media_url": "abc123",
        "secure_base_static_url": "xyz789",
        "secure_base_url": "abc123",
        "send_friend": SendFriendConfiguration,
        "show_cms_breadcrumbs": 987,
        "store_code": "4",
        "store_group_code": 4,
        "store_group_name": "xyz789",
        "store_name": "xyz789",
        "store_sort_order": 987,
        "timezone": "abc123",
        "title_prefix": "abc123",
        "title_separator": "xyz789",
        "title_suffix": "xyz789",
        "use_store_in_url": true,
        "website_code": 4,
        "website_id": 123,
        "website_name": "xyz789",
        "weight_unit": "abc123",
        "welcome": "abc123",
        "zero_subtotal_enable_for_specific_countries": false,
        "zero_subtotal_enabled": false,
        "zero_subtotal_new_order_status": "abc123",
        "zero_subtotal_payment_action": "abc123",
        "zero_subtotal_payment_from_specific_countries": "xyz789",
        "zero_subtotal_sort_order": 123,
        "zero_subtotal_title": "abc123"
      }
    ]
  }
}

cart

Description

(BETA) Return information about the specified shopping cart.

Response

Returns a Cart

Arguments
Name Description
cart_id - String! (BETA) The unique ID of the cart to query.

Example

Query
query cart($cart_id: String!) {
  cart(cart_id: $cart_id) {
    applied_coupon {
      ...AppliedCouponFragment
    }
    applied_coupons {
      ...AppliedCouponFragment
    }
    applied_gift_cards {
      ...AppliedGiftCardFragment
    }
    applied_reward_points {
      ...RewardPointsAmountFragment
    }
    applied_store_credit {
      ...AppliedStoreCreditFragment
    }
    available_gift_wrappings {
      ...GiftWrappingFragment
    }
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    billing_address {
      ...BillingCartAddressFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    id
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    prices {
      ...CartPricesFragment
    }
    printed_card_included
    selected_payment_method {
      ...SelectedPaymentMethodFragment
    }
    shipping_addresses {
      ...ShippingCartAddressFragment
    }
    total_quantity
  }
}
Variables
{"cart_id": "abc123"}
Response
{
  "data": {
    "cart": {
      "applied_coupon": AppliedCoupon,
      "applied_coupons": [AppliedCoupon],
      "applied_gift_cards": [AppliedGiftCard],
      "applied_reward_points": RewardPointsAmount,
      "applied_store_credit": AppliedStoreCredit,
      "available_gift_wrappings": [GiftWrapping],
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "billing_address": BillingCartAddress,
      "email": "xyz789",
      "gift_message": GiftMessage,
      "gift_receipt_included": true,
      "gift_wrapping": GiftWrapping,
      "id": "4",
      "is_virtual": false,
      "items": [CartItemInterface],
      "prices": CartPrices,
      "printed_card_included": false,
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 987.65
    }
  }
}

categories

Description

(BETA) Return a list of categories that match the specified filter.

Response

Returns a CategoryResult

Arguments
Name Description
filters - CategoryFilterInput (BETA) Identifies which Category filter inputs to search for and return.
pageSize - Int (BETA) Specifies the maximum number of results to return at once. The default value is 20. Default = 20
currentPage - Int (BETA) Specifies which page of results to return. The default value is 1. Default = 1

Example

Query
query categories(
  $filters: CategoryFilterInput,
  $pageSize: Int,
  $currentPage: Int
) {
  categories(
    filters: $filters,
    pageSize: $pageSize,
    currentPage: $currentPage
  ) {
    items {
      ...CategoryTreeFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    total_count
  }
}
Variables
{
  "filters": CategoryFilterInput,
  "pageSize": 20,
  "currentPage": 1
}
Response
{
  "data": {
    "categories": {
      "items": [CategoryTree],
      "page_info": SearchResultPageInfo,
      "total_count": 987
    }
  }
}

category

Use categories instead.
Description

(BETA) Search for categories that match the criteria specified in the search and filter attributes.

Response

Returns a CategoryTree

Arguments
Name Description
id - Int (BETA) The category ID to use as the root of the search.

Example

Query
query category($id: Int) {
  category(id: $id) {
    automatic_sorting
    available_sort_by
    breadcrumbs {
      ...BreadcrumbFragment
    }
    canonical_url
    children {
      ...CategoryTreeFragment
    }
    children_count
    cms_block {
      ...CmsBlockFragment
    }
    created_at
    custom_layout_update_file
    default_sort_by
    description
    display_mode
    filter_price_range
    id
    image
    include_in_menu
    is_anchor
    landing_page
    level
    meta_description
    meta_keywords
    meta_title
    name
    path
    path_in_store
    position
    product_count
    products {
      ...CategoryProductsFragment
    }
    redirect_code
    relative_url
    staged
    type
    uid
    updated_at
    url_key
    url_path
    url_suffix
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "category": {
      "automatic_sorting": "xyz789",
      "available_sort_by": ["abc123"],
      "breadcrumbs": [Breadcrumb],
      "canonical_url": "abc123",
      "children": [CategoryTree],
      "children_count": "xyz789",
      "cms_block": CmsBlock,
      "created_at": "abc123",
      "custom_layout_update_file": "xyz789",
      "default_sort_by": "xyz789",
      "description": "xyz789",
      "display_mode": "xyz789",
      "filter_price_range": 123.45,
      "id": 987,
      "image": "xyz789",
      "include_in_menu": 123,
      "is_anchor": 123,
      "landing_page": 123,
      "level": 987,
      "meta_description": "abc123",
      "meta_keywords": "abc123",
      "meta_title": "xyz789",
      "name": "abc123",
      "path": "xyz789",
      "path_in_store": "xyz789",
      "position": 987,
      "product_count": 123,
      "products": CategoryProducts,
      "redirect_code": 987,
      "relative_url": "xyz789",
      "staged": false,
      "type": "CMS_PAGE",
      "uid": "4",
      "updated_at": "abc123",
      "url_key": "abc123",
      "url_path": "xyz789",
      "url_suffix": "abc123"
    }
  }
}

categoryList

Use categories instead.
Description

(BETA) Return an array of categories based on the specified filters.

Response

Returns [CategoryTree]

Arguments
Name Description
filters - CategoryFilterInput (BETA) Identifies which Category filter inputs to search for and return.
pageSize - Int (BETA) Specifies the maximum number of results to return at once. The default value is 20. Default = 20
currentPage - Int (BETA) Specifies which page of results to return. The default value is 1. Default = 1

Example

Query
query categoryList(
  $filters: CategoryFilterInput,
  $pageSize: Int,
  $currentPage: Int
) {
  categoryList(
    filters: $filters,
    pageSize: $pageSize,
    currentPage: $currentPage
  ) {
    automatic_sorting
    available_sort_by
    breadcrumbs {
      ...BreadcrumbFragment
    }
    canonical_url
    children {
      ...CategoryTreeFragment
    }
    children_count
    cms_block {
      ...CmsBlockFragment
    }
    created_at
    custom_layout_update_file
    default_sort_by
    description
    display_mode
    filter_price_range
    id
    image
    include_in_menu
    is_anchor
    landing_page
    level
    meta_description
    meta_keywords
    meta_title
    name
    path
    path_in_store
    position
    product_count
    products {
      ...CategoryProductsFragment
    }
    redirect_code
    relative_url
    staged
    type
    uid
    updated_at
    url_key
    url_path
    url_suffix
  }
}
Variables
{
  "filters": CategoryFilterInput,
  "pageSize": 20,
  "currentPage": 1
}
Response
{
  "data": {
    "categoryList": [
      {
        "automatic_sorting": "xyz789",
        "available_sort_by": ["abc123"],
        "breadcrumbs": [Breadcrumb],
        "canonical_url": "abc123",
        "children": [CategoryTree],
        "children_count": "xyz789",
        "cms_block": CmsBlock,
        "created_at": "abc123",
        "custom_layout_update_file": "xyz789",
        "default_sort_by": "xyz789",
        "description": "abc123",
        "display_mode": "abc123",
        "filter_price_range": 123.45,
        "id": 987,
        "image": "abc123",
        "include_in_menu": 123,
        "is_anchor": 987,
        "landing_page": 987,
        "level": 987,
        "meta_description": "abc123",
        "meta_keywords": "xyz789",
        "meta_title": "xyz789",
        "name": "xyz789",
        "path": "xyz789",
        "path_in_store": "xyz789",
        "position": 987,
        "product_count": 987,
        "products": CategoryProducts,
        "redirect_code": 987,
        "relative_url": "abc123",
        "staged": false,
        "type": "CMS_PAGE",
        "uid": 4,
        "updated_at": "abc123",
        "url_key": "abc123",
        "url_path": "xyz789",
        "url_suffix": "xyz789"
      }
    ]
  }
}

checkoutAgreements

Description

(BETA) Return Terms and Conditions configuration information.

Response

Returns [CheckoutAgreement]

Example

Query
query checkoutAgreements {
  checkoutAgreements {
    agreement_id
    checkbox_text
    content
    content_height
    is_html
    mode
    name
  }
}
Response
{
  "data": {
    "checkoutAgreements": [
      {
        "agreement_id": 123,
        "checkbox_text": "xyz789",
        "content": "xyz789",
        "content_height": "xyz789",
        "is_html": true,
        "mode": "AUTO",
        "name": "xyz789"
      }
    ]
  }
}

cmsBlocks

Description

(BETA) Return information about CMS blocks.

Response

Returns a CmsBlocks

Arguments
Name Description
identifiers - [String] (BETA) An array of CMS block IDs.

Example

Query
query cmsBlocks($identifiers: [String]) {
  cmsBlocks(identifiers: $identifiers) {
    items {
      ...CmsBlockFragment
    }
  }
}
Variables
{"identifiers": ["abc123"]}
Response
{"data": {"cmsBlocks": {"items": [CmsBlock]}}}

cmsPage

Description

(BETA) Return details about a CMS page.

Response

Returns a CmsPage

Arguments
Name Description
id - Int (BETA) The ID of the CMS page.
identifier - String (BETA) The identifier of the CMS page.

Example

Query
query cmsPage(
  $id: Int,
  $identifier: String
) {
  cmsPage(
    id: $id,
    identifier: $identifier
  ) {
    content
    content_heading
    identifier
    meta_description
    meta_keywords
    meta_title
    page_layout
    redirect_code
    relative_url
    title
    type
    url_key
  }
}
Variables
{"id": 123, "identifier": "xyz789"}
Response
{
  "data": {
    "cmsPage": {
      "content": "abc123",
      "content_heading": "abc123",
      "identifier": "abc123",
      "meta_description": "abc123",
      "meta_keywords": "abc123",
      "meta_title": "xyz789",
      "page_layout": "abc123",
      "redirect_code": 123,
      "relative_url": "abc123",
      "title": "abc123",
      "type": "CMS_PAGE",
      "url_key": "abc123"
    }
  }
}

company

Description

(BETA) Return detailed information about the authenticated customer's company.

Response

Returns a Company

Example

Query
query company {
  company {
    acl_resources {
      ...CompanyAclResourceFragment
    }
    company_admin {
      ...CustomerFragment
    }
    credit {
      ...CompanyCreditFragment
    }
    credit_history {
      ...CompanyCreditHistoryFragment
    }
    email
    id
    legal_address {
      ...CompanyLegalAddressFragment
    }
    legal_name
    name
    payment_methods
    reseller_id
    role {
      ...CompanyRoleFragment
    }
    roles {
      ...CompanyRolesFragment
    }
    sales_representative {
      ...CompanySalesRepresentativeFragment
    }
    structure {
      ...CompanyStructureFragment
    }
    team {
      ...CompanyTeamFragment
    }
    user {
      ...CustomerFragment
    }
    users {
      ...CompanyUsersFragment
    }
    vat_tax_id
  }
}
Response
{
  "data": {
    "company": {
      "acl_resources": [CompanyAclResource],
      "company_admin": Customer,
      "credit": CompanyCredit,
      "credit_history": CompanyCreditHistory,
      "email": "xyz789",
      "id": 4,
      "legal_address": CompanyLegalAddress,
      "legal_name": "xyz789",
      "name": "abc123",
      "payment_methods": ["xyz789"],
      "reseller_id": "abc123",
      "role": CompanyRole,
      "roles": CompanyRoles,
      "sales_representative": CompanySalesRepresentative,
      "structure": CompanyStructure,
      "team": CompanyTeam,
      "user": Customer,
      "users": CompanyUsers,
      "vat_tax_id": "xyz789"
    }
  }
}

compareList

Description

(BETA) Return products that have been added to the specified compare list.

Response

Returns a CompareList

Arguments
Name Description
uid - ID! (BETA) The unique ID of the compare list to be queried.

Example

Query
query compareList($uid: ID!) {
  compareList(uid: $uid) {
    attributes {
      ...ComparableAttributeFragment
    }
    item_count
    items {
      ...ComparableItemFragment
    }
    uid
  }
}
Variables
{"uid": "4"}
Response
{
  "data": {
    "compareList": {
      "attributes": [ComparableAttribute],
      "item_count": 987,
      "items": [ComparableItem],
      "uid": "4"
    }
  }
}

countries

Description

(BETA) The countries query provides information for all countries.

Response

Returns [Country]

Example

Query
query countries {
  countries {
    available_regions {
      ...RegionFragment
    }
    full_name_english
    full_name_locale
    id
    three_letter_abbreviation
    two_letter_abbreviation
  }
}
Response
{
  "data": {
    "countries": [
      {
        "available_regions": [Region],
        "full_name_english": "xyz789",
        "full_name_locale": "abc123",
        "id": "xyz789",
        "three_letter_abbreviation": "xyz789",
        "two_letter_abbreviation": "xyz789"
      }
    ]
  }
}

country

Description

(BETA) The countries query provides information for a single country.

Response

Returns a Country

Arguments
Name Description
id - String

Example

Query
query country($id: String) {
  country(id: $id) {
    available_regions {
      ...RegionFragment
    }
    full_name_english
    full_name_locale
    id
    three_letter_abbreviation
    two_letter_abbreviation
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "country": {
      "available_regions": [Region],
      "full_name_english": "xyz789",
      "full_name_locale": "xyz789",
      "id": "abc123",
      "three_letter_abbreviation": "xyz789",
      "two_letter_abbreviation": "xyz789"
    }
  }
}

currency

Description

(BETA) Return information about the store's currency.

Response

Returns a Currency

Example

Query
query currency {
  currency {
    available_currency_codes
    base_currency_code
    base_currency_symbol
    default_display_currecy_code
    default_display_currecy_symbol
    default_display_currency_code
    default_display_currency_symbol
    exchange_rates {
      ...ExchangeRateFragment
    }
  }
}
Response
{
  "data": {
    "currency": {
      "available_currency_codes": [
        "xyz789"
      ],
      "base_currency_code": "xyz789",
      "base_currency_symbol": "xyz789",
      "default_display_currecy_code": "xyz789",
      "default_display_currecy_symbol": "xyz789",
      "default_display_currency_code": "abc123",
      "default_display_currency_symbol": "abc123",
      "exchange_rates": [ExchangeRate]
    }
  }
}

customAttributeMetadata

Description

(BETA) Return the attribute type, given an attribute code and entity type.

Response

Returns a CustomAttributeMetadata

Arguments
Name Description
attributes - [AttributeInput!]! (BETA) An input object that specifies the attribute code and entity type to search.

Example

Query
query customAttributeMetadata($attributes: [AttributeInput!]!) {
  customAttributeMetadata(attributes: $attributes) {
    items {
      ...AttributeFragment
    }
  }
}
Variables
{"attributes": [AttributeInput]}
Response
{
  "data": {
    "customAttributeMetadata": {"items": [Attribute]}
  }
}

customer

Description

(BETA) Return detailed information about a customer account.

Response

Returns a Customer

Example

Query
query customer {
  customer {
    addresses {
      ...CustomerAddressFragment
    }
    allow_remote_shopping_assistance
    compare_list {
      ...CompareListFragment
    }
    created_at
    date_of_birth
    default_billing
    default_shipping
    dob
    email
    firstname
    gender
    gift_registries {
      ...GiftRegistryFragment
    }
    gift_registry {
      ...GiftRegistryFragment
    }
    group_id
    id
    is_subscribed
    job_title
    lastname
    middlename
    orders {
      ...CustomerOrdersFragment
    }
    prefix
    purchase_order {
      ...PurchaseOrderFragment
    }
    purchase_order_approval_rule {
      ...PurchaseOrderApprovalRuleFragment
    }
    purchase_order_approval_rule_metadata {
      ...PurchaseOrderApprovalRuleMetadataFragment
    }
    purchase_order_approval_rules {
      ...PurchaseOrderApprovalRulesFragment
    }
    purchase_orders {
      ...PurchaseOrdersFragment
    }
    purchase_orders_enabled
    requisition_lists {
      ...RequisitionListsFragment
    }
    return {
      ...ReturnFragment
    }
    returns {
      ...ReturnsFragment
    }
    reviews {
      ...ProductReviewsFragment
    }
    reward_points {
      ...RewardPointsFragment
    }
    role {
      ...CompanyRoleFragment
    }
    status
    store_credit {
      ...CustomerStoreCreditFragment
    }
    structure_id
    suffix
    taxvat
    team {
      ...CompanyTeamFragment
    }
    telephone
    wishlist {
      ...WishlistFragment
    }
    wishlist_v2 {
      ...WishlistFragment
    }
    wishlists {
      ...WishlistFragment
    }
  }
}
Response
{
  "data": {
    "customer": {
      "addresses": [CustomerAddress],
      "allow_remote_shopping_assistance": true,
      "compare_list": CompareList,
      "created_at": "abc123",
      "date_of_birth": "abc123",
      "default_billing": "abc123",
      "default_shipping": "abc123",
      "dob": "abc123",
      "email": "xyz789",
      "firstname": "xyz789",
      "gender": 987,
      "gift_registries": [GiftRegistry],
      "gift_registry": GiftRegistry,
      "group_id": 987,
      "id": 123,
      "is_subscribed": true,
      "job_title": "xyz789",
      "lastname": "abc123",
      "middlename": "abc123",
      "orders": CustomerOrders,
      "prefix": "xyz789",
      "purchase_order": PurchaseOrder,
      "purchase_order_approval_rule": PurchaseOrderApprovalRule,
      "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
      "purchase_order_approval_rules": PurchaseOrderApprovalRules,
      "purchase_orders": PurchaseOrders,
      "purchase_orders_enabled": true,
      "requisition_lists": RequisitionLists,
      "return": Return,
      "returns": Returns,
      "reviews": ProductReviews,
      "reward_points": RewardPoints,
      "role": CompanyRole,
      "status": "ACTIVE",
      "store_credit": CustomerStoreCredit,
      "structure_id": 4,
      "suffix": "xyz789",
      "taxvat": "abc123",
      "team": CompanyTeam,
      "telephone": "abc123",
      "wishlist": Wishlist,
      "wishlist_v2": Wishlist,
      "wishlists": [Wishlist]
    }
  }
}

customerCart

Description

(BETA) Return information about the customer's shopping cart.

Response

Returns a Cart!

Example

Query
query customerCart {
  customerCart {
    applied_coupon {
      ...AppliedCouponFragment
    }
    applied_coupons {
      ...AppliedCouponFragment
    }
    applied_gift_cards {
      ...AppliedGiftCardFragment
    }
    applied_reward_points {
      ...RewardPointsAmountFragment
    }
    applied_store_credit {
      ...AppliedStoreCreditFragment
    }
    available_gift_wrappings {
      ...GiftWrappingFragment
    }
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    billing_address {
      ...BillingCartAddressFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    id
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    prices {
      ...CartPricesFragment
    }
    printed_card_included
    selected_payment_method {
      ...SelectedPaymentMethodFragment
    }
    shipping_addresses {
      ...ShippingCartAddressFragment
    }
    total_quantity
  }
}
Response
{
  "data": {
    "customerCart": {
      "applied_coupon": AppliedCoupon,
      "applied_coupons": [AppliedCoupon],
      "applied_gift_cards": [AppliedGiftCard],
      "applied_reward_points": RewardPointsAmount,
      "applied_store_credit": AppliedStoreCredit,
      "available_gift_wrappings": [GiftWrapping],
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "billing_address": BillingCartAddress,
      "email": "abc123",
      "gift_message": GiftMessage,
      "gift_receipt_included": false,
      "gift_wrapping": GiftWrapping,
      "id": 4,
      "is_virtual": false,
      "items": [CartItemInterface],
      "prices": CartPrices,
      "printed_card_included": true,
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 123.45
    }
  }
}

customerDownloadableProducts

Description

(BETA) Return a list of downloadable products the customer has purchased.

Response

Returns a CustomerDownloadableProducts

Example

Query
query customerDownloadableProducts {
  customerDownloadableProducts {
    items {
      ...CustomerDownloadableProductFragment
    }
  }
}
Response
{
  "data": {
    "customerDownloadableProducts": {
      "items": [CustomerDownloadableProduct]
    }
  }
}

customerOrders

Use the customer query instead.
Response

Returns a CustomerOrders

Example

Query
query customerOrders {
  customerOrders {
    items {
      ...CustomerOrderFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    total_count
  }
}
Response
{
  "data": {
    "customerOrders": {
      "items": [CustomerOrder],
      "page_info": SearchResultPageInfo,
      "total_count": 987
    }
  }
}

customerPaymentTokens

Description

(BETA) Return a list of customer payment tokens stored in the vault.

Response

Returns a CustomerPaymentTokens

Example

Query
query customerPaymentTokens {
  customerPaymentTokens {
    items {
      ...PaymentTokenFragment
    }
  }
}
Response
{
  "data": {
    "customerPaymentTokens": {"items": [PaymentToken]}
  }
}

dynamicBlocks

Description

(BETA) Return a list of dynamic blocks filtered by type, location, or UIDs.

Response

Returns a DynamicBlocks!

Arguments
Name Description
input - DynamicBlocksFilterInput (BETA) Defines the filter for returning matching dynamic blocks.
pageSize - Int (BETA) The maximum number of results to return at once. The default is 20. Default = 20
currentPage - Int (BETA) The page of results to return. The default is 1. Default = 1

Example

Query
query dynamicBlocks(
  $input: DynamicBlocksFilterInput,
  $pageSize: Int,
  $currentPage: Int
) {
  dynamicBlocks(
    input: $input,
    pageSize: $pageSize,
    currentPage: $currentPage
  ) {
    items {
      ...DynamicBlockFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    total_count
  }
}
Variables
{
  "input": DynamicBlocksFilterInput,
  "pageSize": 20,
  "currentPage": 1
}
Response
{
  "data": {
    "dynamicBlocks": {
      "items": [DynamicBlock],
      "page_info": SearchResultPageInfo,
      "total_count": 987
    }
  }
}

getHostedProUrl

Description

(BETA) Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction.

Response

Returns a HostedProUrl

Arguments
Name Description
input - HostedProUrlInput! (BETA) An input object that specifies the cart ID.

Example

Query
query getHostedProUrl($input: HostedProUrlInput!) {
  getHostedProUrl(input: $input) {
    secure_form_url
  }
}
Variables
{"input": HostedProUrlInput}
Response
{
  "data": {
    "getHostedProUrl": {
      "secure_form_url": "abc123"
    }
  }
}

getPayflowLinkToken

Description

(BETA) Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods.

Response

Returns a PayflowLinkToken

Arguments
Name Description
input - PayflowLinkTokenInput! (BETA) An input object that defines the requirements to receive a payment token.

Example

Query
query getPayflowLinkToken($input: PayflowLinkTokenInput!) {
  getPayflowLinkToken(input: $input) {
    mode
    paypal_url
    secure_token
    secure_token_id
  }
}
Variables
{"input": PayflowLinkTokenInput}
Response
{
  "data": {
    "getPayflowLinkToken": {
      "mode": "TEST",
      "paypal_url": "xyz789",
      "secure_token": "xyz789",
      "secure_token_id": "abc123"
    }
  }
}

giftCardAccount

Description

(BETA) Return details about a specific gift card.

Response

Returns a GiftCardAccount

Arguments
Name Description
input - GiftCardAccountInput! (BETA) An input object that specifies the gift card code.

Example

Query
query giftCardAccount($input: GiftCardAccountInput!) {
  giftCardAccount(input: $input) {
    balance {
      ...MoneyFragment
    }
    code
    expiration_date
  }
}
Variables
{"input": GiftCardAccountInput}
Response
{
  "data": {
    "giftCardAccount": {
      "balance": Money,
      "code": "xyz789",
      "expiration_date": "abc123"
    }
  }
}

giftRegistry

Description

(BETA) Return the specified gift registry. Some details will not be available to guests.

Response

Returns a GiftRegistry

Arguments
Name Description
giftRegistryUid - ID! (BETA) The unique ID of the registry to search for.

Example

Query
query giftRegistry($giftRegistryUid: ID!) {
  giftRegistry(giftRegistryUid: $giftRegistryUid) {
    created_at
    dynamic_attributes {
      ...GiftRegistryDynamicAttributeFragment
    }
    event_name
    items {
      ...GiftRegistryItemInterfaceFragment
    }
    message
    owner_name
    privacy_settings
    registrants {
      ...GiftRegistryRegistrantFragment
    }
    shipping_address {
      ...CustomerAddressFragment
    }
    status
    type {
      ...GiftRegistryTypeFragment
    }
    uid
  }
}
Variables
{"giftRegistryUid": "4"}
Response
{
  "data": {
    "giftRegistry": {
      "created_at": "abc123",
      "dynamic_attributes": [
        GiftRegistryDynamicAttribute
      ],
      "event_name": "xyz789",
      "items": [GiftRegistryItemInterface],
      "message": "xyz789",
      "owner_name": "abc123",
      "privacy_settings": "PRIVATE",
      "registrants": [GiftRegistryRegistrant],
      "shipping_address": CustomerAddress,
      "status": "ACTIVE",
      "type": GiftRegistryType,
      "uid": "4"
    }
  }
}

giftRegistryEmailSearch

Description

(BETA) Search for gift registries by specifying a registrant email address.

Response

Returns [GiftRegistrySearchResult]

Arguments
Name Description
email - String! (BETA) The registrant's email.

Example

Query
query giftRegistryEmailSearch($email: String!) {
  giftRegistryEmailSearch(email: $email) {
    event_date
    event_title
    gift_registry_uid
    location
    name
    type
  }
}
Variables
{"email": "xyz789"}
Response
{
  "data": {
    "giftRegistryEmailSearch": [
      {
        "event_date": "xyz789",
        "event_title": "xyz789",
        "gift_registry_uid": 4,
        "location": "xyz789",
        "name": "abc123",
        "type": "xyz789"
      }
    ]
  }
}

giftRegistryIdSearch

Description

(BETA) Search for gift registries by specifying a registry URL key.

Response

Returns [GiftRegistrySearchResult]

Arguments
Name Description
giftRegistryUid - ID! (BETA) The unique ID of the gift registry.

Example

Query
query giftRegistryIdSearch($giftRegistryUid: ID!) {
  giftRegistryIdSearch(giftRegistryUid: $giftRegistryUid) {
    event_date
    event_title
    gift_registry_uid
    location
    name
    type
  }
}
Variables
{"giftRegistryUid": 4}
Response
{
  "data": {
    "giftRegistryIdSearch": [
      {
        "event_date": "abc123",
        "event_title": "abc123",
        "gift_registry_uid": 4,
        "location": "abc123",
        "name": "xyz789",
        "type": "abc123"
      }
    ]
  }
}

giftRegistryTypeSearch

Description

(BETA) Search for gift registries by specifying the registrant name and registry type ID.

Response

Returns [GiftRegistrySearchResult]

Arguments
Name Description
firstName - String! (BETA) The first name of the registrant.
lastName - String! (BETA) The last name of the registrant.
giftRegistryTypeUid - ID (BETA) The type UID of the registry.

Example

Query
query giftRegistryTypeSearch(
  $firstName: String!,
  $lastName: String!,
  $giftRegistryTypeUid: ID
) {
  giftRegistryTypeSearch(
    firstName: $firstName,
    lastName: $lastName,
    giftRegistryTypeUid: $giftRegistryTypeUid
  ) {
    event_date
    event_title
    gift_registry_uid
    location
    name
    type
  }
}
Variables
{
  "firstName": "abc123",
  "lastName": "abc123",
  "giftRegistryTypeUid": "4"
}
Response
{
  "data": {
    "giftRegistryTypeSearch": [
      {
        "event_date": "xyz789",
        "event_title": "abc123",
        "gift_registry_uid": "4",
        "location": "xyz789",
        "name": "xyz789",
        "type": "xyz789"
      }
    ]
  }
}

giftRegistryTypes

Description

(BETA) Get a list of available gift registry types.

Response

Returns [GiftRegistryType]

Example

Query
query giftRegistryTypes {
  giftRegistryTypes {
    dynamic_attributes_metadata {
      ...GiftRegistryDynamicAttributeMetadataInterfaceFragment
    }
    label
    uid
  }
}
Response
{
  "data": {
    "giftRegistryTypes": [
      {
        "dynamic_attributes_metadata": [
          GiftRegistryDynamicAttributeMetadataInterface
        ],
        "label": "abc123",
        "uid": 4
      }
    ]
  }
}

isCompanyAdminEmailAvailable

Description

(BETA) Check whether the specified email can be used to register a company admin.

Arguments
Name Description
email - String!

Example

Query
query isCompanyAdminEmailAvailable($email: String!) {
  isCompanyAdminEmailAvailable(email: $email) {
    is_email_available
  }
}
Variables
{"email": "abc123"}
Response
{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}}

isCompanyEmailAvailable

Description

(BETA) Check whether the specified email can be used to register a new company.

Response

Returns an IsCompanyEmailAvailableOutput

Arguments
Name Description
email - String!

Example

Query
query isCompanyEmailAvailable($email: String!) {
  isCompanyEmailAvailable(email: $email) {
    is_email_available
  }
}
Variables
{"email": "abc123"}
Response
{"data": {"isCompanyEmailAvailable": {"is_email_available": false}}}

isCompanyRoleNameAvailable

Description

(BETA) Check whether the specified role name is valid for the company.

Response

Returns an IsCompanyRoleNameAvailableOutput

Arguments
Name Description
name - String!

Example

Query
query isCompanyRoleNameAvailable($name: String!) {
  isCompanyRoleNameAvailable(name: $name) {
    is_role_name_available
  }
}
Variables
{"name": "xyz789"}
Response
{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}}

isCompanyUserEmailAvailable

Description

(BETA) Check whether the specified email can be used to register a company user.

Response

Returns an IsCompanyUserEmailAvailableOutput

Arguments
Name Description
email - String!

Example

Query
query isCompanyUserEmailAvailable($email: String!) {
  isCompanyUserEmailAvailable(email: $email) {
    is_email_available
  }
}
Variables
{"email": "xyz789"}
Response
{"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}}

isEmailAvailable

Description

(BETA) Check whether the specified email has already been used to create a customer account.

Response

Returns an IsEmailAvailableOutput

Arguments
Name Description
email - String! (BETA) The email address to check.

Example

Query
query isEmailAvailable($email: String!) {
  isEmailAvailable(email: $email) {
    is_email_available
  }
}
Variables
{"email": "abc123"}
Response
{"data": {"isEmailAvailable": {"is_email_available": true}}}

negotiableQuote

Description

(BETA) Retrieve the specified negotiable quote.

Response

Returns a NegotiableQuote

Arguments
Name Description
uid - ID!

Example

Query
query negotiableQuote($uid: ID!) {
  negotiableQuote(uid: $uid) {
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    billing_address {
      ...NegotiableQuoteBillingAddressFragment
    }
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    created_at
    email
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    name
    prices {
      ...CartPricesFragment
    }
    selected_payment_method {
      ...SelectedPaymentMethodFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    total_quantity
    uid
    updated_at
  }
}
Variables
{"uid": "4"}
Response
{
  "data": {
    "negotiableQuote": {
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "billing_address": NegotiableQuoteBillingAddress,
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "created_at": "abc123",
      "email": "abc123",
      "history": [NegotiableQuoteHistoryEntry],
      "is_virtual": true,
      "items": [CartItemInterface],
      "name": "abc123",
      "prices": CartPrices,
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "SUBMITTED",
      "total_quantity": 987.65,
      "uid": "4",
      "updated_at": "xyz789"
    }
  }
}

negotiableQuotes

Description

(BETA) Return a list of negotiable quotes that can be viewed by the logged-in customer.

Response

Returns a NegotiableQuotesOutput

Arguments
Name Description
filter - NegotiableQuoteFilterInput (BETA) The filter to use to determine which negotiable quotes to return.
pageSize - Int (BETA) The maximum number of results to return at once. The default value is 20. Default = 20
currentPage - Int (BETA) The page of results to return. The default value is 1. Default = 1
sort - NegotiableQuoteSortInput (BETA) The field to use for sorting results.

Example

Query
query negotiableQuotes(
  $filter: NegotiableQuoteFilterInput,
  $pageSize: Int,
  $currentPage: Int,
  $sort: NegotiableQuoteSortInput
) {
  negotiableQuotes(
    filter: $filter,
    pageSize: $pageSize,
    currentPage: $currentPage,
    sort: $sort
  ) {
    items {
      ...NegotiableQuoteFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    sort_fields {
      ...SortFieldsFragment
    }
    total_count
  }
}
Variables
{
  "filter": NegotiableQuoteFilterInput,
  "pageSize": 20,
  "currentPage": 1,
  "sort": NegotiableQuoteSortInput
}
Response
{
  "data": {
    "negotiableQuotes": {
      "items": [NegotiableQuote],
      "page_info": SearchResultPageInfo,
      "sort_fields": SortFields,
      "total_count": 123
    }
  }
}

pickupLocations

Description

(BETA) The pickup locations query searches for locations that match the search request requirements.

Response

Returns a PickupLocations

Arguments
Name Description
area - AreaInput (BETA) Perform search by location using radius and search term.
filters - PickupLocationFilterInput (BETA) Apply filters by attributes.
sort - PickupLocationSortInput (BETA) Specifies which attribute to sort on, and whether to return the results in ascending or descending order.
pageSize - Int (BETA) The maximum number of pickup locations to return at once. The attribute is optional. Default = 20
currentPage - Int (BETA) Specifies which page of results to return. The default value is 1. Default = 1
productsInfo - [ProductInfoInput] (BETA) Information about products which should be delivered.

Example

Query
query pickupLocations(
  $area: AreaInput,
  $filters: PickupLocationFilterInput,
  $sort: PickupLocationSortInput,
  $pageSize: Int,
  $currentPage: Int,
  $productsInfo: [ProductInfoInput]
) {
  pickupLocations(
    area: $area,
    filters: $filters,
    sort: $sort,
    pageSize: $pageSize,
    currentPage: $currentPage,
    productsInfo: $productsInfo
  ) {
    items {
      ...PickupLocationFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    total_count
  }
}
Variables
{
  "area": AreaInput,
  "filters": PickupLocationFilterInput,
  "sort": PickupLocationSortInput,
  "pageSize": 20,
  "currentPage": 1,
  "productsInfo": [ProductInfoInput]
}
Response
{
  "data": {
    "pickupLocations": {
      "items": [PickupLocation],
      "page_info": SearchResultPageInfo,
      "total_count": 987
    }
  }
}

productReviewRatingsMetadata

Description

(BETA) Return the active ratings attributes and the values each rating can have.

Response

Returns a ProductReviewRatingsMetadata!

Example

Query
query productReviewRatingsMetadata {
  productReviewRatingsMetadata {
    items {
      ...ProductReviewRatingMetadataFragment
    }
  }
}
Response
{
  "data": {
    "productReviewRatingsMetadata": {
      "items": [ProductReviewRatingMetadata]
    }
  }
}

products

Description

(BETA) Search for products that match the criteria specified in the search and filter attributes.

Response

Returns a Products

Arguments
Name Description
search - String (BETA) One or more keywords to use in a full-text search.
filter - ProductAttributeFilterInput (BETA) The product attributes to search for and return.
pageSize - Int (BETA) The maximum number of results to return at once. The default value is 20. Default = 20
currentPage - Int (BETA) The page of results to return. The default value is 1. Default = 1
sort - ProductAttributeSortInput (BETA) Specifies which attributes to sort on, and whether to return the results in ascending or descending order.

Example

Query
query products(
  $search: String,
  $filter: ProductAttributeFilterInput,
  $pageSize: Int,
  $currentPage: Int,
  $sort: ProductAttributeSortInput
) {
  products(
    search: $search,
    filter: $filter,
    pageSize: $pageSize,
    currentPage: $currentPage,
    sort: $sort
  ) {
    aggregations {
      ...AggregationFragment
    }
    filters {
      ...LayerFilterFragment
    }
    items {
      ...ProductInterfaceFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    sort_fields {
      ...SortFieldsFragment
    }
    suggestions {
      ...SearchSuggestionFragment
    }
    total_count
  }
}
Variables
{
  "search": "abc123",
  "filter": ProductAttributeFilterInput,
  "pageSize": 20,
  "currentPage": 1,
  "sort": ProductAttributeSortInput
}
Response
{
  "data": {
    "products": {
      "aggregations": [Aggregation],
      "filters": [LayerFilter],
      "items": [ProductInterface],
      "page_info": SearchResultPageInfo,
      "sort_fields": SortFields,
      "suggestions": [SearchSuggestion],
      "total_count": 123
    }
  }
}

route

Description

(BETA) Return the full details for a specified product, category, or CMS page.

Response

Returns a RoutableInterface

Arguments
Name Description
url - String! (BETA) A url_key appended by the `url_suffix, if one exists.

Example

Query
query route($url: String!) {
  route(url: $url) {
    redirect_code
    relative_url
    type
  }
}
Variables
{"url": "abc123"}
Response
{
  "data": {
    "route": {
      "redirect_code": 123,
      "relative_url": "xyz789",
      "type": "CMS_PAGE"
    }
  }
}

storeConfig

Description

(BETA) Return details about the store's configuration.

Response

Returns a StoreConfig

Example

Query
query storeConfig {
  storeConfig {
    absolute_footer
    allow_gift_receipt
    allow_gift_wrapping_on_order
    allow_gift_wrapping_on_order_items
    allow_guests_to_write_product_reviews
    allow_items
    allow_order
    allow_printed_card
    autocomplete_on_storefront
    base_currency_code
    base_link_url
    base_media_url
    base_static_url
    base_url
    braintree_cc_vault_active
    cart_gift_wrapping
    cart_printed_card
    catalog_default_sort_by
    category_fixed_product_tax_display_setting
    category_url_suffix
    check_money_order_enable_for_specific_countries
    check_money_order_enabled
    check_money_order_make_check_payable_to
    check_money_order_max_order_total
    check_money_order_min_order_total
    check_money_order_new_order_status
    check_money_order_payment_from_specific_countries
    check_money_order_send_check_to
    check_money_order_sort_order
    check_money_order_title
    cms_home_page
    cms_no_cookies
    cms_no_route
    code
    configurable_thumbnail_source
    copyright
    default_description
    default_display_currency_code
    default_keywords
    default_title
    demonotice
    enable_multiple_wishlists
    front
    grid_per_page
    grid_per_page_values
    head_includes
    head_shortcut_icon
    header_logo_src
    id
    is_default_store
    is_default_store_group
    is_negotiable_quote_active
    is_requisition_list_active
    list_mode
    list_per_page
    list_per_page_values
    locale
    logo_alt
    logo_height
    logo_width
    magento_reward_general_is_enabled
    magento_reward_general_is_enabled_on_front
    magento_reward_general_min_points_balance
    magento_reward_general_publish_history
    magento_reward_points_invitation_customer
    magento_reward_points_invitation_customer_limit
    magento_reward_points_invitation_order
    magento_reward_points_invitation_order_limit
    magento_reward_points_newsletter
    magento_reward_points_order
    magento_reward_points_register
    magento_reward_points_review
    magento_reward_points_review_limit
    magento_wishlist_general_is_enabled
    maximum_number_of_wishlists
    minimum_password_length
    no_route
    payment_payflowpro_cc_vault_active
    printed_card_price
    product_fixed_product_tax_display_setting
    product_reviews_enabled
    product_url_suffix
    required_character_classes_number
    returns_enabled
    root_category_id
    root_category_uid
    sales_fixed_product_tax_display_setting
    sales_gift_wrapping
    sales_printed_card
    secure_base_link_url
    secure_base_media_url
    secure_base_static_url
    secure_base_url
    send_friend {
      ...SendFriendConfigurationFragment
    }
    show_cms_breadcrumbs
    store_code
    store_group_code
    store_group_name
    store_name
    store_sort_order
    timezone
    title_prefix
    title_separator
    title_suffix
    use_store_in_url
    website_code
    website_id
    website_name
    weight_unit
    welcome
    zero_subtotal_enable_for_specific_countries
    zero_subtotal_enabled
    zero_subtotal_new_order_status
    zero_subtotal_payment_action
    zero_subtotal_payment_from_specific_countries
    zero_subtotal_sort_order
    zero_subtotal_title
  }
}
Response
{
  "data": {
    "storeConfig": {
      "absolute_footer": "abc123",
      "allow_gift_receipt": "abc123",
      "allow_gift_wrapping_on_order": "abc123",
      "allow_gift_wrapping_on_order_items": "xyz789",
      "allow_guests_to_write_product_reviews": "xyz789",
      "allow_items": "abc123",
      "allow_order": "xyz789",
      "allow_printed_card": "xyz789",
      "autocomplete_on_storefront": false,
      "base_currency_code": "abc123",
      "base_link_url": "abc123",
      "base_media_url": "xyz789",
      "base_static_url": "abc123",
      "base_url": "abc123",
      "braintree_cc_vault_active": "xyz789",
      "cart_gift_wrapping": "abc123",
      "cart_printed_card": "abc123",
      "catalog_default_sort_by": "abc123",
      "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
      "category_url_suffix": "xyz789",
      "check_money_order_enable_for_specific_countries": false,
      "check_money_order_enabled": false,
      "check_money_order_make_check_payable_to": "xyz789",
      "check_money_order_max_order_total": "xyz789",
      "check_money_order_min_order_total": "abc123",
      "check_money_order_new_order_status": "xyz789",
      "check_money_order_payment_from_specific_countries": "xyz789",
      "check_money_order_send_check_to": "abc123",
      "check_money_order_sort_order": 987,
      "check_money_order_title": "xyz789",
      "cms_home_page": "xyz789",
      "cms_no_cookies": "abc123",
      "cms_no_route": "abc123",
      "code": "xyz789",
      "configurable_thumbnail_source": "xyz789",
      "copyright": "xyz789",
      "default_description": "abc123",
      "default_display_currency_code": "abc123",
      "default_keywords": "abc123",
      "default_title": "xyz789",
      "demonotice": 123,
      "enable_multiple_wishlists": "xyz789",
      "front": "xyz789",
      "grid_per_page": 987,
      "grid_per_page_values": "abc123",
      "head_includes": "xyz789",
      "head_shortcut_icon": "abc123",
      "header_logo_src": "abc123",
      "id": 123,
      "is_default_store": false,
      "is_default_store_group": true,
      "is_negotiable_quote_active": true,
      "is_requisition_list_active": "xyz789",
      "list_mode": "abc123",
      "list_per_page": 123,
      "list_per_page_values": "xyz789",
      "locale": "xyz789",
      "logo_alt": "abc123",
      "logo_height": 123,
      "logo_width": 123,
      "magento_reward_general_is_enabled": "abc123",
      "magento_reward_general_is_enabled_on_front": "xyz789",
      "magento_reward_general_min_points_balance": "abc123",
      "magento_reward_general_publish_history": "abc123",
      "magento_reward_points_invitation_customer": "xyz789",
      "magento_reward_points_invitation_customer_limit": "xyz789",
      "magento_reward_points_invitation_order": "abc123",
      "magento_reward_points_invitation_order_limit": "abc123",
      "magento_reward_points_newsletter": "xyz789",
      "magento_reward_points_order": "xyz789",
      "magento_reward_points_register": "abc123",
      "magento_reward_points_review": "xyz789",
      "magento_reward_points_review_limit": "abc123",
      "magento_wishlist_general_is_enabled": "xyz789",
      "maximum_number_of_wishlists": "xyz789",
      "minimum_password_length": "xyz789",
      "no_route": "abc123",
      "payment_payflowpro_cc_vault_active": "xyz789",
      "printed_card_price": "abc123",
      "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
      "product_reviews_enabled": "xyz789",
      "product_url_suffix": "xyz789",
      "required_character_classes_number": "abc123",
      "returns_enabled": "xyz789",
      "root_category_id": 123,
      "root_category_uid": "4",
      "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
      "sales_gift_wrapping": "abc123",
      "sales_printed_card": "abc123",
      "secure_base_link_url": "abc123",
      "secure_base_media_url": "xyz789",
      "secure_base_static_url": "xyz789",
      "secure_base_url": "abc123",
      "send_friend": SendFriendConfiguration,
      "show_cms_breadcrumbs": 123,
      "store_code": "4",
      "store_group_code": 4,
      "store_group_name": "xyz789",
      "store_name": "xyz789",
      "store_sort_order": 123,
      "timezone": "xyz789",
      "title_prefix": "xyz789",
      "title_separator": "xyz789",
      "title_suffix": "abc123",
      "use_store_in_url": false,
      "website_code": 4,
      "website_id": 123,
      "website_name": "xyz789",
      "weight_unit": "abc123",
      "welcome": "xyz789",
      "zero_subtotal_enable_for_specific_countries": false,
      "zero_subtotal_enabled": false,
      "zero_subtotal_new_order_status": "abc123",
      "zero_subtotal_payment_action": "xyz789",
      "zero_subtotal_payment_from_specific_countries": "xyz789",
      "zero_subtotal_sort_order": 987,
      "zero_subtotal_title": "xyz789"
    }
  }
}

urlResolver

Use the route query instead.
Description

(BETA) Return the relative URL for a specified product, category or CMS page.

Response

Returns an EntityUrl

Arguments
Name Description
url - String! (BETA) A url_key appended by the `url_suffix, if one exists.

Example

Query
query urlResolver($url: String!) {
  urlResolver(url: $url) {
    canonical_url
    entity_uid
    id
    redirectCode
    relative_url
    type
  }
}
Variables
{"url": "abc123"}
Response
{
  "data": {
    "urlResolver": {
      "canonical_url": "abc123",
      "entity_uid": "4",
      "id": 123,
      "redirectCode": 987,
      "relative_url": "xyz789",
      "type": "CMS_PAGE"
    }
  }
}

wishlist

Moved under Customer.wishlist.
Description

(BETA) Return the contents of a customer's wish list.

Response

Returns a WishlistOutput

Example

Query
query wishlist {
  wishlist {
    items {
      ...WishlistItemFragment
    }
    items_count
    name
    sharing_code
    updated_at
  }
}
Response
{
  "data": {
    "wishlist": {
      "items": [WishlistItem],
      "items_count": 123,
      "name": "xyz789",
      "sharing_code": "abc123",
      "updated_at": "abc123"
    }
  }
}

Mutations

addBundleProductsToCart

Description

(BETA) Add one or more bundle products to the specified cart. We recommend using addProductsToCart instead.

Response

Returns an AddBundleProductsToCartOutput

Arguments
Name Description
input - AddBundleProductsToCartInput (BETA) An input object that defines which bundle products to add to the cart.

Example

Query
mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) {
  addBundleProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": AddBundleProductsToCartInput}
Response
{"data": {"addBundleProductsToCart": {"cart": Cart}}}

addConfigurableProductsToCart

Description

(BETA) Add one or more configurable products to the specified cart. We recommend using addProductsToCart instead.

Arguments
Name Description
input - AddConfigurableProductsToCartInput (BETA) An input object that defines which configurable products to add to the cart.

Example

Query
mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInput) {
  addConfigurableProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": AddConfigurableProductsToCartInput}
Response
{
  "data": {
    "addConfigurableProductsToCart": {"cart": Cart}
  }
}

addDownloadableProductsToCart

Description

(BETA) Add one or more downloadable products to the specified cart. We recommend using addProductsToCart instead.

Arguments
Name Description
input - AddDownloadableProductsToCartInput (BETA) An input object that defines which downloadable products to add to the cart.

Example

Query
mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInput) {
  addDownloadableProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": AddDownloadableProductsToCartInput}
Response
{
  "data": {
    "addDownloadableProductsToCart": {"cart": Cart}
  }
}

addGiftRegistryRegistrants

Description

(BETA) Add registrants to the specified gift registry.

Response

Returns an AddGiftRegistryRegistrantsOutput

Arguments
Name Description
giftRegistryUid - ID! (BETA) The unique ID of the gift registry.
registrants - [AddGiftRegistryRegistrantInput!]! (BETA) An array registrants to add.

Example

Query
mutation addGiftRegistryRegistrants(
  $giftRegistryUid: ID!,
  $registrants: [AddGiftRegistryRegistrantInput!]!
) {
  addGiftRegistryRegistrants(
    giftRegistryUid: $giftRegistryUid,
    registrants: $registrants
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
{
  "giftRegistryUid": 4,
  "registrants": [AddGiftRegistryRegistrantInput]
}
Response
{
  "data": {
    "addGiftRegistryRegistrants": {
      "gift_registry": GiftRegistry
    }
  }
}

addProductsToCart

Description

(BETA) Add any type of product to the cart.

Response

Returns an AddProductsToCartOutput

Arguments
Name Description
cartId - String! (BETA) The cart ID of the shopper.
cartItems - [CartItemInput!]! (BETA) An array that defines the products to add to the cart.

Example

Query
mutation addProductsToCart(
  $cartId: String!,
  $cartItems: [CartItemInput!]!
) {
  addProductsToCart(
    cartId: $cartId,
    cartItems: $cartItems
  ) {
    cart {
      ...CartFragment
    }
    user_errors {
      ...CartUserInputErrorFragment
    }
  }
}
Variables
{
  "cartId": "abc123",
  "cartItems": [CartItemInput]
}
Response
{
  "data": {
    "addProductsToCart": {
      "cart": Cart,
      "user_errors": [CartUserInputError]
    }
  }
}

addProductsToCompareList

Description

(BETA) Add products to the specified compare list.

Response

Returns a CompareList

Arguments
Name Description
input - AddProductsToCompareListInput (BETA) An input object that defines which products to add to an existing compare list.

Example

Query
mutation addProductsToCompareList($input: AddProductsToCompareListInput) {
  addProductsToCompareList(input: $input) {
    attributes {
      ...ComparableAttributeFragment
    }
    item_count
    items {
      ...ComparableItemFragment
    }
    uid
  }
}
Variables
{"input": AddProductsToCompareListInput}
Response
{
  "data": {
    "addProductsToCompareList": {
      "attributes": [ComparableAttribute],
      "item_count": 987,
      "items": [ComparableItem],
      "uid": "4"
    }
  }
}

addProductsToRequisitionList

Description

(BETA) Add items to the specified requisition list.

Arguments
Name Description
requisitionListUid - ID! (BETA) The unique ID of the requisition list.
requisitionListItems - [RequisitionListItemsInput!]! (BETA) An array of products to be added to the requisition list.

Example

Query
mutation addProductsToRequisitionList(
  $requisitionListUid: ID!,
  $requisitionListItems: [RequisitionListItemsInput!]!
) {
  addProductsToRequisitionList(
    requisitionListUid: $requisitionListUid,
    requisitionListItems: $requisitionListItems
  ) {
    requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
{
  "requisitionListUid": 4,
  "requisitionListItems": [RequisitionListItemsInput]
}
Response
{
  "data": {
    "addProductsToRequisitionList": {
      "requisition_list": RequisitionList
    }
  }
}

addProductsToWishlist

Description

(BETA) Add one or more products to the specified wish list. This mutation supports all product types.

Response

Returns an AddProductsToWishlistOutput

Arguments
Name Description
wishlistId - ID! (BETA) The ID of a wish list.
wishlistItems - [WishlistItemInput!]! (BETA) An array of products to add to the wish list.

Example

Query
mutation addProductsToWishlist(
  $wishlistId: ID!,
  $wishlistItems: [WishlistItemInput!]!
) {
  addProductsToWishlist(
    wishlistId: $wishlistId,
    wishlistItems: $wishlistItems
  ) {
    user_errors {
      ...WishListUserInputErrorFragment
    }
    wishlist {
      ...WishlistFragment
    }
  }
}
Variables
{"wishlistId": 4, "wishlistItems": [WishlistItemInput]}
Response
{
  "data": {
    "addProductsToWishlist": {
      "user_errors": [WishListUserInputError],
      "wishlist": Wishlist
    }
  }
}

addPurchaseOrderComment

Description

(BETA) Add a comment to an existing purchase order.

Response

Returns an AddPurchaseOrderCommentOutput

Arguments
Name Description
input - AddPurchaseOrderCommentInput!

Example

Query
mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) {
  addPurchaseOrderComment(input: $input) {
    comment {
      ...PurchaseOrderCommentFragment
    }
  }
}
Variables
{"input": AddPurchaseOrderCommentInput}
Response
{
  "data": {
    "addPurchaseOrderComment": {
      "comment": PurchaseOrderComment
    }
  }
}

addPurchaseOrderItemsToCart

Description

(BETA) Add purchase order items to the shopping cart.

Response

Returns an AddProductsToCartOutput

Arguments
Name Description
input - AddPurchaseOrderItemsToCartInput!

Example

Query
mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) {
  addPurchaseOrderItemsToCart(input: $input) {
    cart {
      ...CartFragment
    }
    user_errors {
      ...CartUserInputErrorFragment
    }
  }
}
Variables
{"input": AddPurchaseOrderItemsToCartInput}
Response
{
  "data": {
    "addPurchaseOrderItemsToCart": {
      "cart": Cart,
      "user_errors": [CartUserInputError]
    }
  }
}

addRequisitionListItemsToCart

Description

(BETA) Add items in the requisition list to the customer's cart.

Arguments
Name Description
requisitionListUid - ID! (BETA) The unique ID of the requisition list.
requisitionListItemUids - [ID!] (BETA) An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart.

Example

Query
mutation addRequisitionListItemsToCart(
  $requisitionListUid: ID!,
  $requisitionListItemUids: [ID!]
) {
  addRequisitionListItemsToCart(
    requisitionListUid: $requisitionListUid,
    requisitionListItemUids: $requisitionListItemUids
  ) {
    add_requisition_list_items_to_cart_user_errors {
      ...AddRequisitionListItemToCartUserErrorFragment
    }
    cart {
      ...CartFragment
    }
    status
  }
}
Variables
{"requisitionListUid": 4, "requisitionListItemUids": [4]}
Response
{
  "data": {
    "addRequisitionListItemsToCart": {
      "add_requisition_list_items_to_cart_user_errors": [
        AddRequisitionListItemToCartUserError
      ],
      "cart": Cart,
      "status": true
    }
  }
}

addReturnComment

Description

(BETA) Add a comment to an existing return.

Response

Returns an AddReturnCommentOutput

Arguments
Name Description
input - AddReturnCommentInput! (BETA) An input object that defines a return comment.

Example

Query
mutation addReturnComment($input: AddReturnCommentInput!) {
  addReturnComment(input: $input) {
    return {
      ...ReturnFragment
    }
  }
}
Variables
{"input": AddReturnCommentInput}
Response
{"data": {"addReturnComment": {"return": Return}}}

addReturnTracking

Description

(BETA) Add tracking information to the return.

Response

Returns an AddReturnTrackingOutput

Arguments
Name Description
input - AddReturnTrackingInput! (BETA) An input object that defines tracking information.

Example

Query
mutation addReturnTracking($input: AddReturnTrackingInput!) {
  addReturnTracking(input: $input) {
    return {
      ...ReturnFragment
    }
    return_shipping_tracking {
      ...ReturnShippingTrackingFragment
    }
  }
}
Variables
{"input": AddReturnTrackingInput}
Response
{
  "data": {
    "addReturnTracking": {
      "return": Return,
      "return_shipping_tracking": ReturnShippingTracking
    }
  }
}

addSimpleProductsToCart

Description

(BETA) Add one or more simple products to the specified cart. We recommend using addProductsToCart instead.

Response

Returns an AddSimpleProductsToCartOutput

Arguments
Name Description
input - AddSimpleProductsToCartInput (BETA) An input object that defines which simple products to add to the cart.

Example

Query
mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) {
  addSimpleProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": AddSimpleProductsToCartInput}
Response
{"data": {"addSimpleProductsToCart": {"cart": Cart}}}

addVirtualProductsToCart

Description

(BETA) Add one or more virtual products to the specified cart. We recommend using addProductsToCart instead.

Response

Returns an AddVirtualProductsToCartOutput

Arguments
Name Description
input - AddVirtualProductsToCartInput (BETA) An input object that defines which virtual products to add to the cart.

Example

Query
mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) {
  addVirtualProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": AddVirtualProductsToCartInput}
Response
{"data": {"addVirtualProductsToCart": {"cart": Cart}}}

addWishlistItemsToCart

Description

(BETA) Add items in the specified wishlist to the customer's cart.

Response

Returns an AddWishlistItemsToCartOutput

Arguments
Name Description
wishlistId - ID! (BETA) The unique ID of the wish list
wishlistItemIds - [ID!] (BETA) An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart

Example

Query
mutation addWishlistItemsToCart(
  $wishlistId: ID!,
  $wishlistItemIds: [ID!]
) {
  addWishlistItemsToCart(
    wishlistId: $wishlistId,
    wishlistItemIds: $wishlistItemIds
  ) {
    add_wishlist_items_to_cart_user_errors {
      ...WishlistCartUserInputErrorFragment
    }
    status
    wishlist {
      ...WishlistFragment
    }
  }
}
Variables
{"wishlistId": 4, "wishlistItemIds": [4]}
Response
{
  "data": {
    "addWishlistItemsToCart": {
      "add_wishlist_items_to_cart_user_errors": [
        WishlistCartUserInputError
      ],
      "status": false,
      "wishlist": Wishlist
    }
  }
}

applyCouponToCart

Description

(BETA) Apply a pre-defined coupon code to the specified cart.

Response

Returns an ApplyCouponToCartOutput

Arguments
Name Description
input - ApplyCouponToCartInput (BETA) An input object that defines the coupon code to apply to the cart.

Example

Query
mutation applyCouponToCart($input: ApplyCouponToCartInput) {
  applyCouponToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": ApplyCouponToCartInput}
Response
{"data": {"applyCouponToCart": {"cart": Cart}}}

applyGiftCardToCart

Description

(BETA) Apply a pre-defined gift card code to the specified cart.

Response

Returns an ApplyGiftCardToCartOutput

Arguments
Name Description
input - ApplyGiftCardToCartInput (BETA) An input object that specifies the gift card code and cart.

Example

Query
mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) {
  applyGiftCardToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": ApplyGiftCardToCartInput}
Response
{"data": {"applyGiftCardToCart": {"cart": Cart}}}

applyRewardPointsToCart

Description

(BETA) Apply all available points, up to the cart total. Partial redemption is not available.

Response

Returns an ApplyRewardPointsToCartOutput

Arguments
Name Description
cartId - ID!

Example

Query
mutation applyRewardPointsToCart($cartId: ID!) {
  applyRewardPointsToCart(cartId: $cartId) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"cartId": 4}
Response
{"data": {"applyRewardPointsToCart": {"cart": Cart}}}

applyStoreCreditToCart

Description

(BETA) Apply store credit to the specified cart.

Response

Returns an ApplyStoreCreditToCartOutput

Arguments
Name Description
input - ApplyStoreCreditToCartInput! (BETA) An input object that specifies the cart ID.

Example

Query
mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) {
  applyStoreCreditToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": ApplyStoreCreditToCartInput}
Response
{"data": {"applyStoreCreditToCart": {"cart": Cart}}}

approvePurchaseOrders

Description

(BETA) Approve purchase orders.

Response

Returns a PurchaseOrdersActionOutput

Arguments
Name Description
input - PurchaseOrdersActionInput!

Example

Query
mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) {
  approvePurchaseOrders(input: $input) {
    errors {
      ...PurchaseOrderActionErrorFragment
    }
    purchase_orders {
      ...PurchaseOrderFragment
    }
  }
}
Variables
{"input": PurchaseOrdersActionInput}
Response
{
  "data": {
    "approvePurchaseOrders": {
      "errors": [PurchaseOrderActionError],
      "purchase_orders": [PurchaseOrder]
    }
  }
}

assignCompareListToCustomer

Description

(BETA) Assign the specified compare list to the logged in customer.

Response

Returns an AssignCompareListToCustomerOutput

Arguments
Name Description
uid - ID! (BETA) The unique ID of the compare list to be assigned.

Example

Query
mutation assignCompareListToCustomer($uid: ID!) {
  assignCompareListToCustomer(uid: $uid) {
    compare_list {
      ...CompareListFragment
    }
    result
  }
}
Variables
{"uid": 4}
Response
{
  "data": {
    "assignCompareListToCustomer": {
      "compare_list": CompareList,
      "result": true
    }
  }
}

assignCustomerToGuestCart

Description

(BETA) Assign a logged-in customer to the specified guest shopping cart.

Response

Returns a Cart!

Arguments
Name Description
cart_id - String!

Example

Query
mutation assignCustomerToGuestCart($cart_id: String!) {
  assignCustomerToGuestCart(cart_id: $cart_id) {
    applied_coupon {
      ...AppliedCouponFragment
    }
    applied_coupons {
      ...AppliedCouponFragment
    }
    applied_gift_cards {
      ...AppliedGiftCardFragment
    }
    applied_reward_points {
      ...RewardPointsAmountFragment
    }
    applied_store_credit {
      ...AppliedStoreCreditFragment
    }
    available_gift_wrappings {
      ...GiftWrappingFragment
    }
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    billing_address {
      ...BillingCartAddressFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    id
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    prices {
      ...CartPricesFragment
    }
    printed_card_included
    selected_payment_method {
      ...SelectedPaymentMethodFragment
    }
    shipping_addresses {
      ...ShippingCartAddressFragment
    }
    total_quantity
  }
}
Variables
{"cart_id": "abc123"}
Response
{
  "data": {
    "assignCustomerToGuestCart": {
      "applied_coupon": AppliedCoupon,
      "applied_coupons": [AppliedCoupon],
      "applied_gift_cards": [AppliedGiftCard],
      "applied_reward_points": RewardPointsAmount,
      "applied_store_credit": AppliedStoreCredit,
      "available_gift_wrappings": [GiftWrapping],
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "billing_address": BillingCartAddress,
      "email": "abc123",
      "gift_message": GiftMessage,
      "gift_receipt_included": false,
      "gift_wrapping": GiftWrapping,
      "id": "4",
      "is_virtual": true,
      "items": [CartItemInterface],
      "prices": CartPrices,
      "printed_card_included": false,
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 123.45
    }
  }
}

cancelPurchaseOrders

Description

(BETA) Cancel purchase orders.

Response

Returns a PurchaseOrdersActionOutput

Arguments
Name Description
input - PurchaseOrdersActionInput!

Example

Query
mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) {
  cancelPurchaseOrders(input: $input) {
    errors {
      ...PurchaseOrderActionErrorFragment
    }
    purchase_orders {
      ...PurchaseOrderFragment
    }
  }
}
Variables
{"input": PurchaseOrdersActionInput}
Response
{
  "data": {
    "cancelPurchaseOrders": {
      "errors": [PurchaseOrderActionError],
      "purchase_orders": [PurchaseOrder]
    }
  }
}

changeCustomerPassword

Description

(BETA) Change the password for the logged-in customer.

Response

Returns a Customer

Arguments
Name Description
currentPassword - String! (BETA) The customer's original password.
newPassword - String! (BETA) The customer's updated password.

Example

Query
mutation changeCustomerPassword(
  $currentPassword: String!,
  $newPassword: String!
) {
  changeCustomerPassword(
    currentPassword: $currentPassword,
    newPassword: $newPassword
  ) {
    addresses {
      ...CustomerAddressFragment
    }
    allow_remote_shopping_assistance
    compare_list {
      ...CompareListFragment
    }
    created_at
    date_of_birth
    default_billing
    default_shipping
    dob
    email
    firstname
    gender
    gift_registries {
      ...GiftRegistryFragment
    }
    gift_registry {
      ...GiftRegistryFragment
    }
    group_id
    id
    is_subscribed
    job_title
    lastname
    middlename
    orders {
      ...CustomerOrdersFragment
    }
    prefix
    purchase_order {
      ...PurchaseOrderFragment
    }
    purchase_order_approval_rule {
      ...PurchaseOrderApprovalRuleFragment
    }
    purchase_order_approval_rule_metadata {
      ...PurchaseOrderApprovalRuleMetadataFragment
    }
    purchase_order_approval_rules {
      ...PurchaseOrderApprovalRulesFragment
    }
    purchase_orders {
      ...PurchaseOrdersFragment
    }
    purchase_orders_enabled
    requisition_lists {
      ...RequisitionListsFragment
    }
    return {
      ...ReturnFragment
    }
    returns {
      ...ReturnsFragment
    }
    reviews {
      ...ProductReviewsFragment
    }
    reward_points {
      ...RewardPointsFragment
    }
    role {
      ...CompanyRoleFragment
    }
    status
    store_credit {
      ...CustomerStoreCreditFragment
    }
    structure_id
    suffix
    taxvat
    team {
      ...CompanyTeamFragment
    }
    telephone
    wishlist {
      ...WishlistFragment
    }
    wishlist_v2 {
      ...WishlistFragment
    }
    wishlists {
      ...WishlistFragment
    }
  }
}
Variables
{
  "currentPassword": "abc123",
  "newPassword": "abc123"
}
Response
{
  "data": {
    "changeCustomerPassword": {
      "addresses": [CustomerAddress],
      "allow_remote_shopping_assistance": false,
      "compare_list": CompareList,
      "created_at": "abc123",
      "date_of_birth": "abc123",
      "default_billing": "xyz789",
      "default_shipping": "abc123",
      "dob": "abc123",
      "email": "abc123",
      "firstname": "xyz789",
      "gender": 987,
      "gift_registries": [GiftRegistry],
      "gift_registry": GiftRegistry,
      "group_id": 987,
      "id": 987,
      "is_subscribed": false,
      "job_title": "abc123",
      "lastname": "abc123",
      "middlename": "xyz789",
      "orders": CustomerOrders,
      "prefix": "xyz789",
      "purchase_order": PurchaseOrder,
      "purchase_order_approval_rule": PurchaseOrderApprovalRule,
      "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
      "purchase_order_approval_rules": PurchaseOrderApprovalRules,
      "purchase_orders": PurchaseOrders,
      "purchase_orders_enabled": false,
      "requisition_lists": RequisitionLists,
      "return": Return,
      "returns": Returns,
      "reviews": ProductReviews,
      "reward_points": RewardPoints,
      "role": CompanyRole,
      "status": "ACTIVE",
      "store_credit": CustomerStoreCredit,
      "structure_id": "4",
      "suffix": "abc123",
      "taxvat": "abc123",
      "team": CompanyTeam,
      "telephone": "xyz789",
      "wishlist": Wishlist,
      "wishlist_v2": Wishlist,
      "wishlists": [Wishlist]
    }
  }
}

clearCustomerCart

Description

(BETA) Remove all items from the specified cart.

Response

Returns a ClearCustomerCartOutput

Arguments
Name Description
cartUid - String! (BETA) The masked ID of the cart.

Example

Query
mutation clearCustomerCart($cartUid: String!) {
  clearCustomerCart(cartUid: $cartUid) {
    cart {
      ...CartFragment
    }
    status
  }
}
Variables
{"cartUid": "abc123"}
Response
{
  "data": {
    "clearCustomerCart": {"cart": Cart, "status": false}
  }
}

closeNegotiableQuotes

Description

(BETA) Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront.

Response

Returns a CloseNegotiableQuotesOutput

Arguments
Name Description
input - CloseNegotiableQuotesInput! (BETA) An input object that closes a negotiable quote.

Example

Query
mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) {
  closeNegotiableQuotes(input: $input) {
    closed_quotes {
      ...NegotiableQuoteFragment
    }
    negotiable_quotes {
      ...NegotiableQuotesOutputFragment
    }
    operation_results {
      ... on NegotiableQuoteUidOperationSuccess {
        ...NegotiableQuoteUidOperationSuccessFragment
      }
      ... on CloseNegotiableQuoteOperationFailure {
        ...CloseNegotiableQuoteOperationFailureFragment
      }
    }
    result_status
  }
}
Variables
{"input": CloseNegotiableQuotesInput}
Response
{
  "data": {
    "closeNegotiableQuotes": {
      "closed_quotes": [NegotiableQuote],
      "negotiable_quotes": NegotiableQuotesOutput,
      "operation_results": [
        NegotiableQuoteUidOperationSuccess
      ],
      "result_status": "SUCCESS"
    }
  }
}

copyItemsBetweenRequisitionLists

Description

(BETA) Copy items from one requisition list to another.

Arguments
Name Description
sourceRequisitionListUid - ID! (BETA) The unique ID of the source requisition list.
destinationRequisitionListUid - ID (BETA) The unique ID of the destination requisition list. If null, a new requisition list will be created.
requisitionListItem - CopyItemsBetweenRequisitionListsInput (BETA) The list of products to copy.

Example

Query
mutation copyItemsBetweenRequisitionLists(
  $sourceRequisitionListUid: ID!,
  $destinationRequisitionListUid: ID,
  $requisitionListItem: CopyItemsBetweenRequisitionListsInput
) {
  copyItemsBetweenRequisitionLists(
    sourceRequisitionListUid: $sourceRequisitionListUid,
    destinationRequisitionListUid: $destinationRequisitionListUid,
    requisitionListItem: $requisitionListItem
  ) {
    requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
{
  "sourceRequisitionListUid": 4,
  "destinationRequisitionListUid": "4",
  "requisitionListItem": CopyItemsBetweenRequisitionListsInput
}
Response
{
  "data": {
    "copyItemsBetweenRequisitionLists": {
      "requisition_list": RequisitionList
    }
  }
}

copyProductsBetweenWishlists

Description

(BETA) Copy products from one wish list to another. The original wish list is unchanged.

Arguments
Name Description
sourceWishlistUid - ID! (BETA) The ID of the original wish list.
destinationWishlistUid - ID! (BETA) The ID of the target wish list.
wishlistItems - [WishlistItemCopyInput!]! (BETA) An array of items to copy.

Example

Query
mutation copyProductsBetweenWishlists(
  $sourceWishlistUid: ID!,
  $destinationWishlistUid: ID!,
  $wishlistItems: [WishlistItemCopyInput!]!
) {
  copyProductsBetweenWishlists(
    sourceWishlistUid: $sourceWishlistUid,
    destinationWishlistUid: $destinationWishlistUid,
    wishlistItems: $wishlistItems
  ) {
    destination_wishlist {
      ...WishlistFragment
    }
    source_wishlist {
      ...WishlistFragment
    }
    user_errors {
      ...WishListUserInputErrorFragment
    }
  }
}
Variables
{
  "sourceWishlistUid": 4,
  "destinationWishlistUid": "4",
  "wishlistItems": [WishlistItemCopyInput]
}
Response
{
  "data": {
    "copyProductsBetweenWishlists": {
      "destination_wishlist": Wishlist,
      "source_wishlist": Wishlist,
      "user_errors": [WishListUserInputError]
    }
  }
}

createBraintreeClientToken

Description

(BETA) Creates Client Token for Braintree Javascript SDK initialization.

Response

Returns a String!

Example

Query
mutation createBraintreeClientToken {
  createBraintreeClientToken
}
Response
{
  "data": {
    "createBraintreeClientToken": "abc123"
  }
}

createCompany

Description

(BETA) Create a company at the request of either a customer or a guest.

Response

Returns a CreateCompanyOutput

Arguments
Name Description
input - CompanyCreateInput!

Example

Query
mutation createCompany($input: CompanyCreateInput!) {
  createCompany(input: $input) {
    company {
      ...CompanyFragment
    }
  }
}
Variables
{"input": CompanyCreateInput}
Response
{"data": {"createCompany": {"company": Company}}}

createCompanyRole

Description

(BETA) Create a new company role.

Response

Returns a CreateCompanyRoleOutput

Arguments
Name Description
input - CompanyRoleCreateInput!

Example

Query
mutation createCompanyRole($input: CompanyRoleCreateInput!) {
  createCompanyRole(input: $input) {
    role {
      ...CompanyRoleFragment
    }
  }
}
Variables
{"input": CompanyRoleCreateInput}
Response
{"data": {"createCompanyRole": {"role": CompanyRole}}}

createCompanyTeam

Description

(BETA) Create a new team for the authenticated customer's company.

Response

Returns a CreateCompanyTeamOutput

Arguments
Name Description
input - CompanyTeamCreateInput!

Example

Query
mutation createCompanyTeam($input: CompanyTeamCreateInput!) {
  createCompanyTeam(input: $input) {
    team {
      ...CompanyTeamFragment
    }
  }
}
Variables
{"input": CompanyTeamCreateInput}
Response
{"data": {"createCompanyTeam": {"team": CompanyTeam}}}

createCompanyUser

Description

(BETA) Create a new company user at the request of an existing customer.

Response

Returns a CreateCompanyUserOutput

Arguments
Name Description
input - CompanyUserCreateInput!

Example

Query
mutation createCompanyUser($input: CompanyUserCreateInput!) {
  createCompanyUser(input: $input) {
    user {
      ...CustomerFragment
    }
  }
}
Variables
{"input": CompanyUserCreateInput}
Response
{"data": {"createCompanyUser": {"user": Customer}}}

createCompareList

Description

(BETA) Create a new compare list. The compare list is saved for logged in customers.

Response

Returns a CompareList

Arguments
Name Description
input - CreateCompareListInput

Example

Query
mutation createCompareList($input: CreateCompareListInput) {
  createCompareList(input: $input) {
    attributes {
      ...ComparableAttributeFragment
    }
    item_count
    items {
      ...ComparableItemFragment
    }
    uid
  }
}
Variables
{"input": CreateCompareListInput}
Response
{
  "data": {
    "createCompareList": {
      "attributes": [ComparableAttribute],
      "item_count": 987,
      "items": [ComparableItem],
      "uid": "4"
    }
  }
}

createCustomer

Description

(BETA) Use createCustomerV2 instead.

Response

Returns a CustomerOutput

Arguments
Name Description
input - CustomerInput! (BETA) An input object that defines the customer to be created.

Example

Query
mutation createCustomer($input: CustomerInput!) {
  createCustomer(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}
Variables
{"input": CustomerInput}
Response
{"data": {"createCustomer": {"customer": Customer}}}

createCustomerAddress

Description

(BETA) Create a billing or shipping address for a customer or guest.

Response

Returns a CustomerAddress

Arguments
Name Description
input - CustomerAddressInput!

Example

Query
mutation createCustomerAddress($input: CustomerAddressInput!) {
  createCustomerAddress(input: $input) {
    city
    company
    country_code
    country_id
    custom_attributes {
      ...CustomerAddressAttributeFragment
    }
    customer_id
    default_billing
    default_shipping
    extension_attributes {
      ...CustomerAddressAttributeFragment
    }
    fax
    firstname
    id
    lastname
    middlename
    postcode
    prefix
    region {
      ...CustomerAddressRegionFragment
    }
    region_id
    street
    suffix
    telephone
    vat_id
  }
}
Variables
{"input": CustomerAddressInput}
Response
{
  "data": {
    "createCustomerAddress": {
      "city": "xyz789",
      "company": "xyz789",
      "country_code": "AF",
      "country_id": "xyz789",
      "custom_attributes": [CustomerAddressAttribute],
      "customer_id": 987,
      "default_billing": false,
      "default_shipping": false,
      "extension_attributes": [CustomerAddressAttribute],
      "fax": "xyz789",
      "firstname": "abc123",
      "id": 123,
      "lastname": "xyz789",
      "middlename": "xyz789",
      "postcode": "abc123",
      "prefix": "xyz789",
      "region": CustomerAddressRegion,
      "region_id": 987,
      "street": ["abc123"],
      "suffix": "abc123",
      "telephone": "abc123",
      "vat_id": "xyz789"
    }
  }
}

createCustomerV2

Description

(BETA) Create a customer account.

Response

Returns a CustomerOutput

Arguments
Name Description
input - CustomerCreateInput! (BETA) An input object that defines the customer to be created.

Example

Query
mutation createCustomerV2($input: CustomerCreateInput!) {
  createCustomerV2(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}
Variables
{"input": CustomerCreateInput}
Response
{"data": {"createCustomerV2": {"customer": Customer}}}

createEmptyCart

Description

(BETA) Create an empty shopping cart for a guest or logged in user

Response

Returns a String

Arguments
Name Description
input - createEmptyCartInput (BETA) An optional input object that assigns the specified ID to the cart.

Example

Query
mutation createEmptyCart($input: createEmptyCartInput) {
  createEmptyCart(input: $input)
}
Variables
{"input": createEmptyCartInput}
Response
{"data": {"createEmptyCart": "abc123"}}

createGiftRegistry

Description

(BETA) Create a gift registry on behalf of the customer.

Response

Returns a CreateGiftRegistryOutput

Arguments
Name Description
giftRegistry - CreateGiftRegistryInput! (BETA) An input object that defines a new gift registry.

Example

Query
mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) {
  createGiftRegistry(giftRegistry: $giftRegistry) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
{"giftRegistry": CreateGiftRegistryInput}
Response
{
  "data": {
    "createGiftRegistry": {"gift_registry": GiftRegistry}
  }
}

createPayflowProToken

Description

(BETA) Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods

Response

Returns a CreatePayflowProTokenOutput

Arguments
Name Description
input - PayflowProTokenInput! (BETA) An input object that defines the requirements to fetch payment token information.

Example

Query
mutation createPayflowProToken($input: PayflowProTokenInput!) {
  createPayflowProToken(input: $input) {
    response_message
    result
    result_code
    secure_token
    secure_token_id
  }
}
Variables
{"input": PayflowProTokenInput}
Response
{
  "data": {
    "createPayflowProToken": {
      "response_message": "abc123",
      "result": 987,
      "result_code": 123,
      "secure_token": "xyz789",
      "secure_token_id": "xyz789"
    }
  }
}

createPaypalExpressToken

Description

(BETA) Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods.

Response

Returns a PaypalExpressTokenOutput

Arguments
Name Description
input - PaypalExpressTokenInput! (BETA) An input object that defines the requirements to receive a payment token.

Example

Query
mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) {
  createPaypalExpressToken(input: $input) {
    paypal_urls {
      ...PaypalExpressUrlListFragment
    }
    token
  }
}
Variables
{"input": PaypalExpressTokenInput}
Response
{
  "data": {
    "createPaypalExpressToken": {
      "paypal_urls": PaypalExpressUrlList,
      "token": "abc123"
    }
  }
}

createProductReview

Description

(BETA) Create a product review for the specified product.

Response

Returns a CreateProductReviewOutput!

Arguments
Name Description
input - CreateProductReviewInput! (BETA) An input object that contains the details necessary to create a product review.

Example

Query
mutation createProductReview($input: CreateProductReviewInput!) {
  createProductReview(input: $input) {
    review {
      ...ProductReviewFragment
    }
  }
}
Variables
{"input": CreateProductReviewInput}
Response
{
  "data": {
    "createProductReview": {"review": ProductReview}
  }
}

createPurchaseOrderApprovalRule

Description

(BETA) Create a purchase order approval rule.

Response

Returns a PurchaseOrderApprovalRule

Arguments
Name Description
input - PurchaseOrderApprovalRuleInput!

Example

Query
mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput!) {
  createPurchaseOrderApprovalRule(input: $input) {
    applies_to_roles {
      ...CompanyRoleFragment
    }
    approver_roles {
      ...CompanyRoleFragment
    }
    condition {
      ...PurchaseOrderApprovalRuleConditionInterfaceFragment
    }
    created_at
    created_by
    description
    name
    status
    uid
    updated_at
  }
}
Variables
{"input": PurchaseOrderApprovalRuleInput}
Response
{
  "data": {
    "createPurchaseOrderApprovalRule": {
      "applies_to_roles": [CompanyRole],
      "approver_roles": [CompanyRole],
      "condition": PurchaseOrderApprovalRuleConditionInterface,
      "created_at": "abc123",
      "created_by": "xyz789",
      "description": "abc123",
      "name": "xyz789",
      "status": "ENABLED",
      "uid": 4,
      "updated_at": "xyz789"
    }
  }
}

createRequisitionList

Description

(BETA) Create an empty requisition list.

Response

Returns a CreateRequisitionListOutput

Arguments
Name Description
input - CreateRequisitionListInput

Example

Query
mutation createRequisitionList($input: CreateRequisitionListInput) {
  createRequisitionList(input: $input) {
    requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
{"input": CreateRequisitionListInput}
Response
{
  "data": {
    "createRequisitionList": {
      "requisition_list": RequisitionList
    }
  }
}

createWishlist

Description

(BETA) Create a new wish list.

Response

Returns a CreateWishlistOutput

Arguments
Name Description
input - CreateWishlistInput! (BETA) An input object that defines a new wish list.

Example

Query
mutation createWishlist($input: CreateWishlistInput!) {
  createWishlist(input: $input) {
    wishlist {
      ...WishlistFragment
    }
  }
}
Variables
{"input": CreateWishlistInput}
Response
{"data": {"createWishlist": {"wishlist": Wishlist}}}

deleteCompanyRole

Description

(BETA) Delete the specified company role.

Response

Returns a DeleteCompanyRoleOutput

Arguments
Name Description
id - ID!

Example

Query
mutation deleteCompanyRole($id: ID!) {
  deleteCompanyRole(id: $id) {
    success
  }
}
Variables
{"id": 4}
Response
{"data": {"deleteCompanyRole": {"success": true}}}

deleteCompanyTeam

Description

(BETA) Delete the specified company team.

Response

Returns a DeleteCompanyTeamOutput

Arguments
Name Description
id - ID!

Example

Query
mutation deleteCompanyTeam($id: ID!) {
  deleteCompanyTeam(id: $id) {
    success
  }
}
Variables
{"id": 4}
Response
{"data": {"deleteCompanyTeam": {"success": true}}}

deleteCompanyUser

Description

(BETA) Delete the specified company user.

Response

Returns a DeleteCompanyUserOutput

Arguments
Name Description
id - ID!

Example

Query
mutation deleteCompanyUser($id: ID!) {
  deleteCompanyUser(id: $id) {
    success
  }
}
Variables
{"id": "4"}
Response
{"data": {"deleteCompanyUser": {"success": true}}}

deleteCompareList

Description

(BETA) Delete the specified compare list.

Response

Returns a DeleteCompareListOutput

Arguments
Name Description
uid - ID! (BETA) The unique ID of the compare list to be deleted.

Example

Query
mutation deleteCompareList($uid: ID!) {
  deleteCompareList(uid: $uid) {
    result
  }
}
Variables
{"uid": 4}
Response
{"data": {"deleteCompareList": {"result": false}}}

deleteCustomer

Description

(BETA) Delete customer account

Response

Returns a Boolean

Example

Query
mutation deleteCustomer {
  deleteCustomer
}
Response
{"data": {"deleteCustomer": true}}

deleteCustomerAddress

Description

(BETA) Delete the billing or shipping address of a customer.

Response

Returns a Boolean

Arguments
Name Description
id - Int! (BETA) The ID of the customer address to be deleted.

Example

Query
mutation deleteCustomerAddress($id: Int!) {
  deleteCustomerAddress(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"deleteCustomerAddress": true}}

deleteNegotiableQuotes

Description

(BETA) Delete a negotiable quote. The negotiable quote will not be displayed on the storefront.

Response

Returns a DeleteNegotiableQuotesOutput

Arguments
Name Description
input - DeleteNegotiableQuotesInput! (BETA) An input object that deletes a negotiable quote.

Example

Query
mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) {
  deleteNegotiableQuotes(input: $input) {
    negotiable_quotes {
      ...NegotiableQuotesOutputFragment
    }
    operation_results {
      ... on NegotiableQuoteUidOperationSuccess {
        ...NegotiableQuoteUidOperationSuccessFragment
      }
      ... on DeleteNegotiableQuoteOperationFailure {
        ...DeleteNegotiableQuoteOperationFailureFragment
      }
    }
    result_status
  }
}
Variables
{"input": DeleteNegotiableQuotesInput}
Response
{
  "data": {
    "deleteNegotiableQuotes": {
      "negotiable_quotes": NegotiableQuotesOutput,
      "operation_results": [
        NegotiableQuoteUidOperationSuccess
      ],
      "result_status": "SUCCESS"
    }
  }
}

deletePaymentToken

Description

(BETA) Delete a customer's payment token.

Response

Returns a DeletePaymentTokenOutput

Arguments
Name Description
public_hash - String! (BETA) The reusable payment token securely stored in the vault.

Example

Query
mutation deletePaymentToken($public_hash: String!) {
  deletePaymentToken(public_hash: $public_hash) {
    customerPaymentTokens {
      ...CustomerPaymentTokensFragment
    }
    result
  }
}
Variables
{"public_hash": "xyz789"}
Response
{
  "data": {
    "deletePaymentToken": {
      "customerPaymentTokens": CustomerPaymentTokens,
      "result": true
    }
  }
}

deletePurchaseOrderApprovalRule

Description

(BETA) Delete existing purchase order approval rules.

Arguments
Name Description
input - DeletePurchaseOrderApprovalRuleInput!

Example

Query
mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRuleInput!) {
  deletePurchaseOrderApprovalRule(input: $input) {
    errors {
      ...DeletePurchaseOrderApprovalRuleErrorFragment
    }
  }
}
Variables
{"input": DeletePurchaseOrderApprovalRuleInput}
Response
{
  "data": {
    "deletePurchaseOrderApprovalRule": {
      "errors": [DeletePurchaseOrderApprovalRuleError]
    }
  }
}

deleteRequisitionList

Description

(BETA) Delete a requisition list.

Response

Returns a DeleteRequisitionListOutput

Arguments
Name Description
requisitionListUid - ID! (BETA) The unique ID of the requisition list.

Example

Query
mutation deleteRequisitionList($requisitionListUid: ID!) {
  deleteRequisitionList(requisitionListUid: $requisitionListUid) {
    requisition_lists {
      ...RequisitionListsFragment
    }
    status
  }
}
Variables
{"requisitionListUid": "4"}
Response
{
  "data": {
    "deleteRequisitionList": {
      "requisition_lists": RequisitionLists,
      "status": true
    }
  }
}

deleteRequisitionListItems

Description

(BETA) Delete items from a requisition list.

Arguments
Name Description
requisitionListUid - ID! (BETA) The unique ID of the requisition list.
requisitionListItemUids - [ID!]! (BETA) An array of UIDs representing products to be removed from the requisition list.

Example

Query
mutation deleteRequisitionListItems(
  $requisitionListUid: ID!,
  $requisitionListItemUids: [ID!]!
) {
  deleteRequisitionListItems(
    requisitionListUid: $requisitionListUid,
    requisitionListItemUids: $requisitionListItemUids
  ) {
    requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
{
  "requisitionListUid": 4,
  "requisitionListItemUids": ["4"]
}
Response
{
  "data": {
    "deleteRequisitionListItems": {
      "requisition_list": RequisitionList
    }
  }
}

deleteWishlist

Description

(BETA) Delete the specified wish list. You cannot delete the customer's default (first) wish list.

Response

Returns a DeleteWishlistOutput

Arguments
Name Description
wishlistId - ID! (BETA) The ID of the wish list to delete.

Example

Query
mutation deleteWishlist($wishlistId: ID!) {
  deleteWishlist(wishlistId: $wishlistId) {
    status
    wishlists {
      ...WishlistFragment
    }
  }
}
Variables
{"wishlistId": "4"}
Response
{
  "data": {
    "deleteWishlist": {
      "status": false,
      "wishlists": [Wishlist]
    }
  }
}

generateCustomerToken

Description

(BETA) Generate a token for specified customer.

Response

Returns a CustomerToken

Arguments
Name Description
email - String! (BETA) The customer's email address.
password - String! (BETA) The customer's password.

Example

Query
mutation generateCustomerToken(
  $email: String!,
  $password: String!
) {
  generateCustomerToken(
    email: $email,
    password: $password
  ) {
    token
  }
}
Variables
{
  "email": "xyz789",
  "password": "abc123"
}
Response
{
  "data": {
    "generateCustomerToken": {
      "token": "xyz789"
    }
  }
}

generateCustomerTokenAsAdmin

Description

(BETA) Request a customer token so that an administrator can perform remote shopping assistance.

Arguments
Name Description
input - GenerateCustomerTokenAsAdminInput! (BETA) An input object that defines the customer email address.

Example

Query
mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput!) {
  generateCustomerTokenAsAdmin(input: $input) {
    customer_token
  }
}
Variables
{"input": GenerateCustomerTokenAsAdminInput}
Response
{
  "data": {
    "generateCustomerTokenAsAdmin": {
      "customer_token": "xyz789"
    }
  }
}

handlePayflowProResponse

Description

(BETA) Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods.

Response

Returns a PayflowProResponseOutput

Arguments
Name Description
input - PayflowProResponseInput! (BETA) An input object that includes the payload returned by PayPal and the cart ID.

Example

Query
mutation handlePayflowProResponse($input: PayflowProResponseInput!) {
  handlePayflowProResponse(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": PayflowProResponseInput}
Response
{"data": {"handlePayflowProResponse": {"cart": Cart}}}

mergeCarts

Description

(BETA) Transfer the contents of a guest cart into the cart of a logged-in customer.

Response

Returns a Cart!

Arguments
Name Description
source_cart_id - String! (BETA) The guest's cart ID before they login.
destination_cart_id - String (BETA) The cart ID after the guest logs in.

Example

Query
mutation mergeCarts(
  $source_cart_id: String!,
  $destination_cart_id: String
) {
  mergeCarts(
    source_cart_id: $source_cart_id,
    destination_cart_id: $destination_cart_id
  ) {
    applied_coupon {
      ...AppliedCouponFragment
    }
    applied_coupons {
      ...AppliedCouponFragment
    }
    applied_gift_cards {
      ...AppliedGiftCardFragment
    }
    applied_reward_points {
      ...RewardPointsAmountFragment
    }
    applied_store_credit {
      ...AppliedStoreCreditFragment
    }
    available_gift_wrappings {
      ...GiftWrappingFragment
    }
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    billing_address {
      ...BillingCartAddressFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    id
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    prices {
      ...CartPricesFragment
    }
    printed_card_included
    selected_payment_method {
      ...SelectedPaymentMethodFragment
    }
    shipping_addresses {
      ...ShippingCartAddressFragment
    }
    total_quantity
  }
}
Variables
{
  "source_cart_id": "xyz789",
  "destination_cart_id": "abc123"
}
Response
{
  "data": {
    "mergeCarts": {
      "applied_coupon": AppliedCoupon,
      "applied_coupons": [AppliedCoupon],
      "applied_gift_cards": [AppliedGiftCard],
      "applied_reward_points": RewardPointsAmount,
      "applied_store_credit": AppliedStoreCredit,
      "available_gift_wrappings": [GiftWrapping],
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "billing_address": BillingCartAddress,
      "email": "xyz789",
      "gift_message": GiftMessage,
      "gift_receipt_included": false,
      "gift_wrapping": GiftWrapping,
      "id": 4,
      "is_virtual": false,
      "items": [CartItemInterface],
      "prices": CartPrices,
      "printed_card_included": false,
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 987.65
    }
  }
}

moveCartItemsToGiftRegistry

Description

(BETA) Move all items from the cart to a gift registry.

Arguments
Name Description
cartUid - ID! (BETA) The unique ID of the cart containing items to be moved to a gift registry.
giftRegistryUid - ID! (BETA) The unique ID of the target gift registry.

Example

Query
mutation moveCartItemsToGiftRegistry(
  $cartUid: ID!,
  $giftRegistryUid: ID!
) {
  moveCartItemsToGiftRegistry(
    cartUid: $cartUid,
    giftRegistryUid: $giftRegistryUid
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
    status
    user_errors {
      ...GiftRegistryItemsUserErrorFragment
    }
  }
}
Variables
{"cartUid": 4, "giftRegistryUid": 4}
Response
{
  "data": {
    "moveCartItemsToGiftRegistry": {
      "gift_registry": GiftRegistry,
      "status": true,
      "user_errors": [GiftRegistryItemsUserError]
    }
  }
}

moveItemsBetweenRequisitionLists

Description

(BETA) Move Items from one requisition list to another.

Arguments
Name Description
sourceRequisitionListUid - ID! (BETA) The unique ID of the source requisition list.
destinationRequisitionListUid - ID (BETA) The unique ID of the destination requisition list. If null, a new requisition list will be created.
requisitionListItem - MoveItemsBetweenRequisitionListsInput (BETA) The list of products to move.

Example

Query
mutation moveItemsBetweenRequisitionLists(
  $sourceRequisitionListUid: ID!,
  $destinationRequisitionListUid: ID,
  $requisitionListItem: MoveItemsBetweenRequisitionListsInput
) {
  moveItemsBetweenRequisitionLists(
    sourceRequisitionListUid: $sourceRequisitionListUid,
    destinationRequisitionListUid: $destinationRequisitionListUid,
    requisitionListItem: $requisitionListItem
  ) {
    destination_requisition_list {
      ...RequisitionListFragment
    }
    source_requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
{
  "sourceRequisitionListUid": "4",
  "destinationRequisitionListUid": "4",
  "requisitionListItem": MoveItemsBetweenRequisitionListsInput
}
Response
{
  "data": {
    "moveItemsBetweenRequisitionLists": {
      "destination_requisition_list": RequisitionList,
      "source_requisition_list": RequisitionList
    }
  }
}

moveProductsBetweenWishlists

Description

(BETA) Move products from one wish list to another.

Arguments
Name Description
sourceWishlistUid - ID! (BETA) The ID of the original wish list.
destinationWishlistUid - ID! (BETA) The ID of the target wish list.
wishlistItems - [WishlistItemMoveInput!]! (BETA) An array of items to move.

Example

Query
mutation moveProductsBetweenWishlists(
  $sourceWishlistUid: ID!,
  $destinationWishlistUid: ID!,
  $wishlistItems: [WishlistItemMoveInput!]!
) {
  moveProductsBetweenWishlists(
    sourceWishlistUid: $sourceWishlistUid,
    destinationWishlistUid: $destinationWishlistUid,
    wishlistItems: $wishlistItems
  ) {
    destination_wishlist {
      ...WishlistFragment
    }
    source_wishlist {
      ...WishlistFragment
    }
    user_errors {
      ...WishListUserInputErrorFragment
    }
  }
}
Variables
{
  "sourceWishlistUid": 4,
  "destinationWishlistUid": "4",
  "wishlistItems": [WishlistItemMoveInput]
}
Response
{
  "data": {
    "moveProductsBetweenWishlists": {
      "destination_wishlist": Wishlist,
      "source_wishlist": Wishlist,
      "user_errors": [WishListUserInputError]
    }
  }
}

placeNegotiableQuoteOrder

Description

(BETA) Convert a negotiable quote into an order.

Response

Returns a PlaceNegotiableQuoteOrderOutput

Arguments
Name Description
input - PlaceNegotiableQuoteOrderInput! (BETA) An input object that specifies the negotiable quote.

Example

Query
mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) {
  placeNegotiableQuoteOrder(input: $input) {
    order {
      ...OrderFragment
    }
  }
}
Variables
{"input": PlaceNegotiableQuoteOrderInput}
Response
{"data": {"placeNegotiableQuoteOrder": {"order": Order}}}

placeOrder

Description

(BETA) Convert the quote into an order.

Response

Returns a PlaceOrderOutput

Arguments
Name Description
input - PlaceOrderInput (BETA) An input object that defines the shopper's cart ID.

Example

Query
mutation placeOrder($input: PlaceOrderInput) {
  placeOrder(input: $input) {
    order {
      ...OrderFragment
    }
  }
}
Variables
{"input": PlaceOrderInput}
Response
{"data": {"placeOrder": {"order": Order}}}

placeOrderForPurchaseOrder

Description

(BETA) Convert the purchase order into an order.

Arguments
Name Description
input - PlaceOrderForPurchaseOrderInput!

Example

Query
mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) {
  placeOrderForPurchaseOrder(input: $input) {
    order {
      ...CustomerOrderFragment
    }
  }
}
Variables
{"input": PlaceOrderForPurchaseOrderInput}
Response
{
  "data": {
    "placeOrderForPurchaseOrder": {"order": CustomerOrder}
  }
}

placePurchaseOrder

Description

(BETA) Place a purchase order.

Response

Returns a PlacePurchaseOrderOutput

Arguments
Name Description
input - PlacePurchaseOrderInput!

Example

Query
mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) {
  placePurchaseOrder(input: $input) {
    purchase_order {
      ...PurchaseOrderFragment
    }
  }
}
Variables
{"input": PlacePurchaseOrderInput}
Response
{
  "data": {
    "placePurchaseOrder": {
      "purchase_order": PurchaseOrder
    }
  }
}

redeemGiftCardBalanceAsStoreCredit

Description

(BETA) Redeem a gift card for store credit.

Response

Returns a GiftCardAccount

Arguments
Name Description
input - GiftCardAccountInput! (BETA) An input object that specifies the gift card code to redeem.

Example

Query
mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) {
  redeemGiftCardBalanceAsStoreCredit(input: $input) {
    balance {
      ...MoneyFragment
    }
    code
    expiration_date
  }
}
Variables
{"input": GiftCardAccountInput}
Response
{
  "data": {
    "redeemGiftCardBalanceAsStoreCredit": {
      "balance": Money,
      "code": "abc123",
      "expiration_date": "xyz789"
    }
  }
}

rejectPurchaseOrders

Description

(BETA) Reject purchase orders.

Response

Returns a PurchaseOrdersActionOutput

Arguments
Name Description
input - PurchaseOrdersActionInput!

Example

Query
mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) {
  rejectPurchaseOrders(input: $input) {
    errors {
      ...PurchaseOrderActionErrorFragment
    }
    purchase_orders {
      ...PurchaseOrderFragment
    }
  }
}
Variables
{"input": PurchaseOrdersActionInput}
Response
{
  "data": {
    "rejectPurchaseOrders": {
      "errors": [PurchaseOrderActionError],
      "purchase_orders": [PurchaseOrder]
    }
  }
}

removeCouponFromCart

Description

(BETA) Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.

Response

Returns a RemoveCouponFromCartOutput

Arguments
Name Description
input - RemoveCouponFromCartInput (BETA) An input object that defines which coupon code to remove from the cart.

Example

Query
mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {
  removeCouponFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": RemoveCouponFromCartInput}
Response
{"data": {"removeCouponFromCart": {"cart": Cart}}}

removeGiftCardFromCart

Description

(BETA) Removes a gift card from the cart.

Response

Returns a RemoveGiftCardFromCartOutput

Arguments
Name Description
input - RemoveGiftCardFromCartInput (BETA) An input object that specifies which gift card code to remove from the cart.

Example

Query
mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) {
  removeGiftCardFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": RemoveGiftCardFromCartInput}
Response
{"data": {"removeGiftCardFromCart": {"cart": Cart}}}

removeGiftRegistry

Description

(BETA) Delete the specified gift registry.

Response

Returns a RemoveGiftRegistryOutput

Arguments
Name Description
giftRegistryUid - ID! (BETA) The unique ID of the gift registry to delete.

Example

Query
mutation removeGiftRegistry($giftRegistryUid: ID!) {
  removeGiftRegistry(giftRegistryUid: $giftRegistryUid) {
    success
  }
}
Variables
{"giftRegistryUid": 4}
Response
{"data": {"removeGiftRegistry": {"success": false}}}

removeGiftRegistryItems

Description

(BETA) Delete the specified items from a gift registry.

Response

Returns a RemoveGiftRegistryItemsOutput

Arguments
Name Description
giftRegistryUid - ID! (BETA) The unique ID of the gift registry.
itemsUid - [ID!]! (BETA) An array of item IDs to remove from the gift registry.

Example

Query
mutation removeGiftRegistryItems(
  $giftRegistryUid: ID!,
  $itemsUid: [ID!]!
) {
  removeGiftRegistryItems(
    giftRegistryUid: $giftRegistryUid,
    itemsUid: $itemsUid
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
{
  "giftRegistryUid": "4",
  "itemsUid": ["4"]
}
Response
{
  "data": {
    "removeGiftRegistryItems": {
      "gift_registry": GiftRegistry
    }
  }
}

removeGiftRegistryRegistrants

Description

(BETA) Removes registrants from a gift registry.

Arguments
Name Description
giftRegistryUid - ID! (BETA) The unique ID of the gift registry.
registrantsUid - [ID!]! (BETA) An array of registrant IDs to remove.

Example

Query
mutation removeGiftRegistryRegistrants(
  $giftRegistryUid: ID!,
  $registrantsUid: [ID!]!
) {
  removeGiftRegistryRegistrants(
    giftRegistryUid: $giftRegistryUid,
    registrantsUid: $registrantsUid
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
{
  "giftRegistryUid": 4,
  "registrantsUid": ["4"]
}
Response
{
  "data": {
    "removeGiftRegistryRegistrants": {
      "gift_registry": GiftRegistry
    }
  }
}

removeItemFromCart

Description

(BETA) Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist.

Response

Returns a RemoveItemFromCartOutput

Arguments
Name Description
input - RemoveItemFromCartInput (BETA) An input object that defines which products to remove from the cart.

Example

Query
mutation removeItemFromCart($input: RemoveItemFromCartInput) {
  removeItemFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": RemoveItemFromCartInput}
Response
{"data": {"removeItemFromCart": {"cart": Cart}}}

removeNegotiableQuoteItems

Description

(BETA) Remove one or more products from a negotiable quote.

Arguments
Name Description
input - RemoveNegotiableQuoteItemsInput! (BETA) An input object that removes one or more items from a negotiable quote.

Example

Query
mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) {
  removeNegotiableQuoteItems(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
{"input": RemoveNegotiableQuoteItemsInput}
Response
{
  "data": {
    "removeNegotiableQuoteItems": {
      "quote": NegotiableQuote
    }
  }
}

removeProductsFromCompareList

Description

(BETA) Remove products from the specified compare list.

Response

Returns a CompareList

Arguments
Name Description
input - RemoveProductsFromCompareListInput (BETA) An input object that defines which products to remove from a compare list.

Example

Query
mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInput) {
  removeProductsFromCompareList(input: $input) {
    attributes {
      ...ComparableAttributeFragment
    }
    item_count
    items {
      ...ComparableItemFragment
    }
    uid
  }
}
Variables
{"input": RemoveProductsFromCompareListInput}
Response
{
  "data": {
    "removeProductsFromCompareList": {
      "attributes": [ComparableAttribute],
      "item_count": 987,
      "items": [ComparableItem],
      "uid": 4
    }
  }
}

removeProductsFromWishlist

Description

(BETA) Remove one or more products from the specified wish list.

Arguments
Name Description
wishlistId - ID! (BETA) The ID of a wish list.
wishlistItemsIds - [ID!]! (BETA) An array of item IDs representing products to be removed.

Example

Query
mutation removeProductsFromWishlist(
  $wishlistId: ID!,
  $wishlistItemsIds: [ID!]!
) {
  removeProductsFromWishlist(
    wishlistId: $wishlistId,
    wishlistItemsIds: $wishlistItemsIds
  ) {
    user_errors {
      ...WishListUserInputErrorFragment
    }
    wishlist {
      ...WishlistFragment
    }
  }
}
Variables
{"wishlistId": "4", "wishlistItemsIds": [4]}
Response
{
  "data": {
    "removeProductsFromWishlist": {
      "user_errors": [WishListUserInputError],
      "wishlist": Wishlist
    }
  }
}

removeReturnTracking

Description

(BETA) Remove a tracked shipment from a return.

Response

Returns a RemoveReturnTrackingOutput

Arguments
Name Description
input - RemoveReturnTrackingInput! (BETA) An input object that removes tracking information.

Example

Query
mutation removeReturnTracking($input: RemoveReturnTrackingInput!) {
  removeReturnTracking(input: $input) {
    return {
      ...ReturnFragment
    }
  }
}
Variables
{"input": RemoveReturnTrackingInput}
Response
{"data": {"removeReturnTracking": {"return": Return}}}

removeRewardPointsFromCart

Description

(BETA) Cancel the application of reward points to the cart.

Arguments
Name Description
cartId - ID!

Example

Query
mutation removeRewardPointsFromCart($cartId: ID!) {
  removeRewardPointsFromCart(cartId: $cartId) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"cartId": "4"}
Response
{"data": {"removeRewardPointsFromCart": {"cart": Cart}}}

removeStoreCreditFromCart

Description

(BETA) Remove store credit that has been applied to the specified cart.

Response

Returns a RemoveStoreCreditFromCartOutput

Arguments
Name Description
input - RemoveStoreCreditFromCartInput! (BETA) An input object that specifies the cart ID.

Example

Query
mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) {
  removeStoreCreditFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": RemoveStoreCreditFromCartInput}
Response
{"data": {"removeStoreCreditFromCart": {"cart": Cart}}}

reorderItems

Description

(BETA) Add all products from a customer's previous order to the cart.

Response

Returns a ReorderItemsOutput

Arguments
Name Description
orderNumber - String!

Example

Query
mutation reorderItems($orderNumber: String!) {
  reorderItems(orderNumber: $orderNumber) {
    cart {
      ...CartFragment
    }
    userInputErrors {
      ...CheckoutUserInputErrorFragment
    }
  }
}
Variables
{"orderNumber": "abc123"}
Response
{
  "data": {
    "reorderItems": {
      "cart": Cart,
      "userInputErrors": [CheckoutUserInputError]
    }
  }
}

requestNegotiableQuote

Description

(BETA) Request a new negotiable quote on behalf of the buyer.

Response

Returns a RequestNegotiableQuoteOutput

Arguments
Name Description
input - RequestNegotiableQuoteInput! (BETA) An input object that contains a request to initiate a negotiable quote.

Example

Query
mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) {
  requestNegotiableQuote(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
{"input": RequestNegotiableQuoteInput}
Response
{
  "data": {
    "requestNegotiableQuote": {"quote": NegotiableQuote}
  }
}

requestPasswordResetEmail

Description

(BETA) Request an email with a reset password token for the registered customer identified by the specified email.

Response

Returns a Boolean

Arguments
Name Description
email - String! (BETA) The customer's email address.

Example

Query
mutation requestPasswordResetEmail($email: String!) {
  requestPasswordResetEmail(email: $email)
}
Variables
{"email": "abc123"}
Response
{"data": {"requestPasswordResetEmail": false}}

requestReturn

Description

(BETA) Initiates a buyer's request to return items for replacement or refund.

Response

Returns a RequestReturnOutput

Arguments
Name Description
input - RequestReturnInput! (BETA) An input object that contains the fields needed to start a return request.

Example

Query
mutation requestReturn($input: RequestReturnInput!) {
  requestReturn(input: $input) {
    return {
      ...ReturnFragment
    }
    returns {
      ...ReturnsFragment
    }
  }
}
Variables
{"input": RequestReturnInput}
Response
{
  "data": {
    "requestReturn": {
      "return": Return,
      "returns": Returns
    }
  }
}

resetPassword

Description

(BETA) Reset a customer's password using the reset password token that the customer received in an email after requesting it using requestPasswordResetEmail.

Response

Returns a Boolean

Arguments
Name Description
email - String! (BETA) The customer's email address.
resetPasswordToken - String! (BETA) A runtime token generated by the requestPasswordResetEmail mutation.
newPassword - String! (BETA) The customer's new password.

Example

Query
mutation resetPassword(
  $email: String!,
  $resetPasswordToken: String!,
  $newPassword: String!
) {
  resetPassword(
    email: $email,
    resetPasswordToken: $resetPasswordToken,
    newPassword: $newPassword
  )
}
Variables
{
  "email": "xyz789",
  "resetPasswordToken": "abc123",
  "newPassword": "xyz789"
}
Response
{"data": {"resetPassword": true}}

revokeCustomerToken

Description

(BETA) Revoke the customer token.

Response

Returns a RevokeCustomerTokenOutput

Example

Query
mutation revokeCustomerToken {
  revokeCustomerToken {
    result
  }
}
Response
{"data": {"revokeCustomerToken": {"result": false}}}

sendEmailToFriend

Description

(BETA) Send a message on behalf of a customer to the specified email addresses.

Response

Returns a SendEmailToFriendOutput

Arguments
Name Description
input - SendEmailToFriendInput (BETA) An input object that defines sender, recipients, and product.

Example

Query
mutation sendEmailToFriend($input: SendEmailToFriendInput) {
  sendEmailToFriend(input: $input) {
    recipients {
      ...SendEmailToFriendRecipientFragment
    }
    sender {
      ...SendEmailToFriendSenderFragment
    }
  }
}
Variables
{"input": SendEmailToFriendInput}
Response
{
  "data": {
    "sendEmailToFriend": {
      "recipients": [SendEmailToFriendRecipient],
      "sender": SendEmailToFriendSender
    }
  }
}

sendNegotiableQuoteForReview

Description

(BETA) Send the negotiable quote to the seller for review.

Arguments
Name Description
input - SendNegotiableQuoteForReviewInput! (BETA) An input object that sends a request for the merchant to review a negotiable quote.

Example

Query
mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput!) {
  sendNegotiableQuoteForReview(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
{"input": SendNegotiableQuoteForReviewInput}
Response
{
  "data": {
    "sendNegotiableQuoteForReview": {
      "quote": NegotiableQuote
    }
  }
}

setBillingAddressOnCart

Description

(BETA) Set the billing address on a specific cart.

Response

Returns a SetBillingAddressOnCartOutput

Arguments
Name Description
input - SetBillingAddressOnCartInput (BETA) An input object that defines the billing address to be assigned to the cart.

Example

Query
mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) {
  setBillingAddressOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": SetBillingAddressOnCartInput}
Response
{"data": {"setBillingAddressOnCart": {"cart": Cart}}}

setGiftOptionsOnCart

Description

(BETA) Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards.

Response

Returns a SetGiftOptionsOnCartOutput

Arguments
Name Description
input - SetGiftOptionsOnCartInput (BETA) An input object that defines the selected gift options.

Example

Query
mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) {
  setGiftOptionsOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": SetGiftOptionsOnCartInput}
Response
{"data": {"setGiftOptionsOnCart": {"cart": Cart}}}

setGuestEmailOnCart

Description

(BETA) Assign the email address of a guest to the cart.

Response

Returns a SetGuestEmailOnCartOutput

Arguments
Name Description
input - SetGuestEmailOnCartInput (BETA) An input object that defines a guest email address.

Example

Query
mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) {
  setGuestEmailOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": SetGuestEmailOnCartInput}
Response
{"data": {"setGuestEmailOnCart": {"cart": Cart}}}

setNegotiableQuoteBillingAddress

Description

(BETA) Assign a billing address to a negotiable quote.

Arguments
Name Description
input - SetNegotiableQuoteBillingAddressInput! (BETA) An input object that defines the billing address to be assigned to a negotiable quote.

Example

Query
mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddressInput!) {
  setNegotiableQuoteBillingAddress(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
{"input": SetNegotiableQuoteBillingAddressInput}
Response
{
  "data": {
    "setNegotiableQuoteBillingAddress": {
      "quote": NegotiableQuote
    }
  }
}

setNegotiableQuotePaymentMethod

Description

(BETA) Set the payment method on a negotiable quote.

Arguments
Name Description
input - SetNegotiableQuotePaymentMethodInput! (BETA) An input object that defines the payment method for the specified negotiable quote.

Example

Query
mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethodInput!) {
  setNegotiableQuotePaymentMethod(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
{"input": SetNegotiableQuotePaymentMethodInput}
Response
{
  "data": {
    "setNegotiableQuotePaymentMethod": {
      "quote": NegotiableQuote
    }
  }
}

setNegotiableQuoteShippingAddress

Description

(BETA) Assign a previously-defined address as the shipping address for a negotiable quote.

Arguments
Name Description
input - SetNegotiableQuoteShippingAddressInput! (BETA) An input object that defines the shipping address to be assigned to a negotiable quote.

Example

Query
mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAddressInput!) {
  setNegotiableQuoteShippingAddress(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
{"input": SetNegotiableQuoteShippingAddressInput}
Response
{
  "data": {
    "setNegotiableQuoteShippingAddress": {
      "quote": NegotiableQuote
    }
  }
}

setNegotiableQuoteShippingMethods

Description

(BETA) Assign the shipping methods on the negotiable quote.

Arguments
Name Description
input - SetNegotiableQuoteShippingMethodsInput! (BETA) An input object that defines the shipping methods to be assigned to a negotiable quote.

Example

Query
mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMethodsInput!) {
  setNegotiableQuoteShippingMethods(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
{"input": SetNegotiableQuoteShippingMethodsInput}
Response
{
  "data": {
    "setNegotiableQuoteShippingMethods": {
      "quote": NegotiableQuote
    }
  }
}

setPaymentMethodAndPlaceOrder

Should use setPaymentMethodOnCart and placeOrder mutations in single request.
Description

(BETA) Set the cart payment method and convert the cart into an order.

Response

Returns a PlaceOrderOutput

Arguments
Name Description
input - SetPaymentMethodAndPlaceOrderInput

Example

Query
mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInput) {
  setPaymentMethodAndPlaceOrder(input: $input) {
    order {
      ...OrderFragment
    }
  }
}
Variables
{"input": SetPaymentMethodAndPlaceOrderInput}
Response
{
  "data": {
    "setPaymentMethodAndPlaceOrder": {"order": Order}
  }
}

setPaymentMethodOnCart

Description

(BETA) Apply a payment method to the cart.

Response

Returns a SetPaymentMethodOnCartOutput

Arguments
Name Description
input - SetPaymentMethodOnCartInput (BETA) An input object that defines which payment method to apply to the cart.

Example

Query
mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) {
  setPaymentMethodOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": SetPaymentMethodOnCartInput}
Response
{"data": {"setPaymentMethodOnCart": {"cart": Cart}}}

setShippingAddressesOnCart

Description

(BETA) Set one or more shipping addresses on a specific cart.

Arguments
Name Description
input - SetShippingAddressesOnCartInput (BETA) An input object that defines one or more shipping addresses to be assigned to the cart.

Example

Query
mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) {
  setShippingAddressesOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": SetShippingAddressesOnCartInput}
Response
{"data": {"setShippingAddressesOnCart": {"cart": Cart}}}

setShippingMethodsOnCart

Description

(BETA) Set one or more delivery methods on a cart.

Response

Returns a SetShippingMethodsOnCartOutput

Arguments
Name Description
input - SetShippingMethodsOnCartInput (BETA) An input object that applies one or more shipping methods to the cart.

Example

Query
mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) {
  setShippingMethodsOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": SetShippingMethodsOnCartInput}
Response
{"data": {"setShippingMethodsOnCart": {"cart": Cart}}}

shareGiftRegistry

Description

(BETA) Send an email about the gift registry to a list of invitees.

Response

Returns a ShareGiftRegistryOutput

Arguments
Name Description
giftRegistryUid - ID! (BETA) The unique ID of the gift registry.
sender - ShareGiftRegistrySenderInput! (BETA) The sender's email address and gift message.
invitees - [ShareGiftRegistryInviteeInput!]! (BETA) An array containing invitee names and email addresses.

Example

Query
mutation shareGiftRegistry(
  $giftRegistryUid: ID!,
  $sender: ShareGiftRegistrySenderInput!,
  $invitees: [ShareGiftRegistryInviteeInput!]!
) {
  shareGiftRegistry(
    giftRegistryUid: $giftRegistryUid,
    sender: $sender,
    invitees: $invitees
  ) {
    is_shared
  }
}
Variables
{
  "giftRegistryUid": "4",
  "sender": ShareGiftRegistrySenderInput,
  "invitees": [ShareGiftRegistryInviteeInput]
}
Response
{"data": {"shareGiftRegistry": {"is_shared": false}}}

subscribeEmailToNewsletter

Description

(BETA) Subscribe the specified email to the store's newsletter.

Arguments
Name Description
email - String! (BETA) The email address that will receive the store's newsletter.

Example

Query
mutation subscribeEmailToNewsletter($email: String!) {
  subscribeEmailToNewsletter(email: $email) {
    status
  }
}
Variables
{"email": "xyz789"}
Response
{"data": {"subscribeEmailToNewsletter": {"status": "NOT_ACTIVE"}}}

updateCartItems

Description

(BETA) Modify items in the cart.

Response

Returns an UpdateCartItemsOutput

Arguments
Name Description
input - UpdateCartItemsInput (BETA) An input object that defines products to be updated.

Example

Query
mutation updateCartItems($input: UpdateCartItemsInput) {
  updateCartItems(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
{"input": UpdateCartItemsInput}
Response
{"data": {"updateCartItems": {"cart": Cart}}}

updateCompany

Description

(BETA) Update company information.

Response

Returns an UpdateCompanyOutput

Arguments
Name Description
input - CompanyUpdateInput!

Example

Query
mutation updateCompany($input: CompanyUpdateInput!) {
  updateCompany(input: $input) {
    company {
      ...CompanyFragment
    }
  }
}
Variables
{"input": CompanyUpdateInput}
Response
{"data": {"updateCompany": {"company": Company}}}

updateCompanyRole

Description

(BETA) Update company role information.

Response

Returns an UpdateCompanyRoleOutput

Arguments
Name Description
input - CompanyRoleUpdateInput!

Example

Query
mutation updateCompanyRole($input: CompanyRoleUpdateInput!) {
  updateCompanyRole(input: $input) {
    role {
      ...CompanyRoleFragment
    }
  }
}
Variables
{"input": CompanyRoleUpdateInput}
Response
{"data": {"updateCompanyRole": {"role": CompanyRole}}}

updateCompanyStructure

Description

(BETA) Change the parent node of a company team.

Response

Returns an UpdateCompanyStructureOutput

Arguments
Name Description
input - CompanyStructureUpdateInput!

Example

Query
mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) {
  updateCompanyStructure(input: $input) {
    company {
      ...CompanyFragment
    }
  }
}
Variables
{"input": CompanyStructureUpdateInput}
Response
{"data": {"updateCompanyStructure": {"company": Company}}}

updateCompanyTeam

Description

(BETA) Update company team data.

Response

Returns an UpdateCompanyTeamOutput

Arguments
Name Description
input - CompanyTeamUpdateInput!

Example

Query
mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) {
  updateCompanyTeam(input: $input) {
    team {
      ...CompanyTeamFragment
    }
  }
}
Variables
{"input": CompanyTeamUpdateInput}
Response
{"data": {"updateCompanyTeam": {"team": CompanyTeam}}}

updateCompanyUser

Description

(BETA) Update an existing company user.

Response

Returns an UpdateCompanyUserOutput

Arguments
Name Description
input - CompanyUserUpdateInput!

Example

Query
mutation updateCompanyUser($input: CompanyUserUpdateInput!) {
  updateCompanyUser(input: $input) {
    user {
      ...CustomerFragment
    }
  }
}
Variables
{"input": CompanyUserUpdateInput}
Response
{"data": {"updateCompanyUser": {"user": Customer}}}

updateCustomer

Description

(BETA) Use updateCustomerV2 instead.

Response

Returns a CustomerOutput

Arguments
Name Description
input - CustomerInput! (BETA) An input object that defines the customer characteristics to update.

Example

Query
mutation updateCustomer($input: CustomerInput!) {
  updateCustomer(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}
Variables
{"input": CustomerInput}
Response
{"data": {"updateCustomer": {"customer": Customer}}}

updateCustomerAddress

Description

(BETA) Update the billing or shipping address of a customer or guest.

Response

Returns a CustomerAddress

Arguments
Name Description
id - Int! (BETA) The ID assigned to the customer address.
input - CustomerAddressInput (BETA) An input object that contains changes to the customer address.

Example

Query
mutation updateCustomerAddress(
  $id: Int!,
  $input: CustomerAddressInput
) {
  updateCustomerAddress(
    id: $id,
    input: $input
  ) {
    city
    company
    country_code
    country_id
    custom_attributes {
      ...CustomerAddressAttributeFragment
    }
    customer_id
    default_billing
    default_shipping
    extension_attributes {
      ...CustomerAddressAttributeFragment
    }
    fax
    firstname
    id
    lastname
    middlename
    postcode
    prefix
    region {
      ...CustomerAddressRegionFragment
    }
    region_id
    street
    suffix
    telephone
    vat_id
  }
}
Variables
{"id": 987, "input": CustomerAddressInput}
Response
{
  "data": {
    "updateCustomerAddress": {
      "city": "abc123",
      "company": "abc123",
      "country_code": "AF",
      "country_id": "abc123",
      "custom_attributes": [CustomerAddressAttribute],
      "customer_id": 123,
      "default_billing": false,
      "default_shipping": true,
      "extension_attributes": [CustomerAddressAttribute],
      "fax": "xyz789",
      "firstname": "abc123",
      "id": 123,
      "lastname": "abc123",
      "middlename": "abc123",
      "postcode": "abc123",
      "prefix": "abc123",
      "region": CustomerAddressRegion,
      "region_id": 123,
      "street": ["xyz789"],
      "suffix": "abc123",
      "telephone": "abc123",
      "vat_id": "abc123"
    }
  }
}

updateCustomerEmail

Description

(BETA) Change the email address for the logged-in customer.

Response

Returns a CustomerOutput

Arguments
Name Description
email - String! (BETA) The customer's email address.
password - String! (BETA) The customer's password.

Example

Query
mutation updateCustomerEmail(
  $email: String!,
  $password: String!
) {
  updateCustomerEmail(
    email: $email,
    password: $password
  ) {
    customer {
      ...CustomerFragment
    }
  }
}
Variables
{
  "email": "xyz789",
  "password": "abc123"
}
Response
{"data": {"updateCustomerEmail": {"customer": Customer}}}

updateCustomerV2

Description

(BETA) Update the customer's personal information.

Response

Returns a CustomerOutput

Arguments
Name Description
input - CustomerUpdateInput! (BETA) An input object that defines the customer characteristics to update.

Example

Query
mutation updateCustomerV2($input: CustomerUpdateInput!) {
  updateCustomerV2(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}
Variables
{"input": CustomerUpdateInput}
Response
{"data": {"updateCustomerV2": {"customer": Customer}}}

updateGiftRegistry

Description

(BETA) Update the specified gift registry.

Response

Returns an UpdateGiftRegistryOutput

Arguments
Name Description
giftRegistryUid - ID! (BETA) The unique ID of an existing gift registry.
giftRegistry - UpdateGiftRegistryInput! (BETA) An input object that defines which fields to update.

Example

Query
mutation updateGiftRegistry(
  $giftRegistryUid: ID!,
  $giftRegistry: UpdateGiftRegistryInput!
) {
  updateGiftRegistry(
    giftRegistryUid: $giftRegistryUid,
    giftRegistry: $giftRegistry
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
{
  "giftRegistryUid": "4",
  "giftRegistry": UpdateGiftRegistryInput
}
Response
{
  "data": {
    "updateGiftRegistry": {"gift_registry": GiftRegistry}
  }
}

updateGiftRegistryItems

Description

(BETA) Update the specified items in the gift registry.

Response

Returns an UpdateGiftRegistryItemsOutput

Arguments
Name Description
giftRegistryUid - ID! (BETA) The unique ID of the gift registry.
items - [UpdateGiftRegistryItemInput!]! (BETA) An array of items to be updated.

Example

Query
mutation updateGiftRegistryItems(
  $giftRegistryUid: ID!,
  $items: [UpdateGiftRegistryItemInput!]!
) {
  updateGiftRegistryItems(
    giftRegistryUid: $giftRegistryUid,
    items: $items
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
{
  "giftRegistryUid": "4",
  "items": [UpdateGiftRegistryItemInput]
}
Response
{
  "data": {
    "updateGiftRegistryItems": {
      "gift_registry": GiftRegistry
    }
  }
}

updateGiftRegistryRegistrants

Description

(BETA) Modify the properties of one or more gift registry registrants.

Arguments
Name Description
giftRegistryUid - ID! (BETA) The unique ID of the gift registry.
registrants - [UpdateGiftRegistryRegistrantInput!]! (BETA) An array of registrants to update.

Example

Query
mutation updateGiftRegistryRegistrants(
  $giftRegistryUid: ID!,
  $registrants: [UpdateGiftRegistryRegistrantInput!]!
) {
  updateGiftRegistryRegistrants(
    giftRegistryUid: $giftRegistryUid,
    registrants: $registrants
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
{
  "giftRegistryUid": 4,
  "registrants": [UpdateGiftRegistryRegistrantInput]
}
Response
{
  "data": {
    "updateGiftRegistryRegistrants": {
      "gift_registry": GiftRegistry
    }
  }
}

updateNegotiableQuoteQuantities

Description

(BETA) Change the quantity of one or more items in an existing negotiable quote.

Arguments
Name Description
input - UpdateNegotiableQuoteQuantitiesInput! (BETA) An input object that changes the quantity of one or more items in a negotiable quote.

Example

Query
mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantitiesInput!) {
  updateNegotiableQuoteQuantities(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
{"input": UpdateNegotiableQuoteQuantitiesInput}
Response
{
  "data": {
    "updateNegotiableQuoteQuantities": {
      "quote": NegotiableQuote
    }
  }
}

updateProductsInWishlist

Description

(BETA) Update one or more products in the specified wish list.

Response

Returns an UpdateProductsInWishlistOutput

Arguments
Name Description
wishlistId - ID! (BETA) The ID of a wish list.
wishlistItems - [WishlistItemUpdateInput!]! (BETA) An array of items to be updated.

Example

Query
mutation updateProductsInWishlist(
  $wishlistId: ID!,
  $wishlistItems: [WishlistItemUpdateInput!]!
) {
  updateProductsInWishlist(
    wishlistId: $wishlistId,
    wishlistItems: $wishlistItems
  ) {
    user_errors {
      ...WishListUserInputErrorFragment
    }
    wishlist {
      ...WishlistFragment
    }
  }
}
Variables
{
  "wishlistId": "4",
  "wishlistItems": [WishlistItemUpdateInput]
}
Response
{
  "data": {
    "updateProductsInWishlist": {
      "user_errors": [WishListUserInputError],
      "wishlist": Wishlist
    }
  }
}

updatePurchaseOrderApprovalRule

Description

(BETA) Update existing purchase order approval rules.

Response

Returns a PurchaseOrderApprovalRule

Arguments
Name Description
input - UpdatePurchaseOrderApprovalRuleInput!

Example

Query
mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRuleInput!) {
  updatePurchaseOrderApprovalRule(input: $input) {
    applies_to_roles {
      ...CompanyRoleFragment
    }
    approver_roles {
      ...CompanyRoleFragment
    }
    condition {
      ...PurchaseOrderApprovalRuleConditionInterfaceFragment
    }
    created_at
    created_by
    description
    name
    status
    uid
    updated_at
  }
}
Variables
{"input": UpdatePurchaseOrderApprovalRuleInput}
Response
{
  "data": {
    "updatePurchaseOrderApprovalRule": {
      "applies_to_roles": [CompanyRole],
      "approver_roles": [CompanyRole],
      "condition": PurchaseOrderApprovalRuleConditionInterface,
      "created_at": "abc123",
      "created_by": "abc123",
      "description": "xyz789",
      "name": "abc123",
      "status": "ENABLED",
      "uid": 4,
      "updated_at": "xyz789"
    }
  }
}

updateRequisitionList

Description

(BETA) Rename a requisition list and change its description.

Response

Returns an UpdateRequisitionListOutput

Arguments
Name Description
requisitionListUid - ID! (BETA) The unique ID of the requisition list.
input - UpdateRequisitionListInput

Example

Query
mutation updateRequisitionList(
  $requisitionListUid: ID!,
  $input: UpdateRequisitionListInput
) {
  updateRequisitionList(
    requisitionListUid: $requisitionListUid,
    input: $input
  ) {
    requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
{
  "requisitionListUid": 4,
  "input": UpdateRequisitionListInput
}
Response
{
  "data": {
    "updateRequisitionList": {
      "requisition_list": RequisitionList
    }
  }
}

updateRequisitionListItems

Description

(BETA) Update items in a requisition list.

Response

Returns an UpdateRequisitionListItemsOutput

Arguments
Name Description
requisitionListUid - ID! (BETA) The unique ID of the requisition list.
requisitionListItems - [UpdateRequisitionListItemsInput!]! (BETA) Items to be updated in the requisition list.

Example

Query
mutation updateRequisitionListItems(
  $requisitionListUid: ID!,
  $requisitionListItems: [UpdateRequisitionListItemsInput!]!
) {
  updateRequisitionListItems(
    requisitionListUid: $requisitionListUid,
    requisitionListItems: $requisitionListItems
  ) {
    requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
{
  "requisitionListUid": "4",
  "requisitionListItems": [
    UpdateRequisitionListItemsInput
  ]
}
Response
{
  "data": {
    "updateRequisitionListItems": {
      "requisition_list": RequisitionList
    }
  }
}

updateWishlist

Description

(BETA) Change the name and visibility of the specified wish list.

Response

Returns an UpdateWishlistOutput

Arguments
Name Description
wishlistId - ID! (BETA) The ID of the wish list to update.
name - String (BETA) The name assigned to the wish list.
visibility - WishlistVisibilityEnum (BETA) Indicates the visibility of the wish list.

Example

Query
mutation updateWishlist(
  $wishlistId: ID!,
  $name: String,
  $visibility: WishlistVisibilityEnum
) {
  updateWishlist(
    wishlistId: $wishlistId,
    name: $name,
    visibility: $visibility
  ) {
    name
    uid
    visibility
  }
}
Variables
{
  "wishlistId": "4",
  "name": "abc123",
  "visibility": "PUBLIC"
}
Response
{
  "data": {
    "updateWishlist": {
      "name": "abc123",
      "uid": 4,
      "visibility": "PUBLIC"
    }
  }
}

validatePurchaseOrders

Description

(BETA) Validate purchase orders.

Response

Returns a ValidatePurchaseOrdersOutput

Arguments
Name Description
input - ValidatePurchaseOrdersInput!

Example

Query
mutation validatePurchaseOrders($input: ValidatePurchaseOrdersInput!) {
  validatePurchaseOrders(input: $input) {
    errors {
      ...ValidatePurchaseOrderErrorFragment
    }
    purchase_orders {
      ...PurchaseOrderFragment
    }
  }
}
Variables
{"input": ValidatePurchaseOrdersInput}
Response
{
  "data": {
    "validatePurchaseOrders": {
      "errors": [ValidatePurchaseOrderError],
      "purchase_orders": [PurchaseOrder]
    }
  }
}

Types

AddBundleProductsToCartInput

Description

(BETA) Defines the bundle products to add to the cart.

Fields
Input Field Description
cart_id - String!

(BETA) The ID of the cart.

cart_items - [BundleProductCartItemInput]!

(BETA) An array of bundle products to add.

Example
{
  "cart_id": "xyz789",
  "cart_items": [BundleProductCartItemInput]
}

AddBundleProductsToCartOutput

Description

(BETA) Contains details about the cart after adding bundle products.

Fields
Field Name Description
cart - Cart! (BETA) The cart after adding products.
Example
{"cart": Cart}

AddConfigurableProductsToCartInput

Description

(BETA) Defines the configurable products to add to the cart.

Fields
Input Field Description
cart_id - String!

(BETA) The ID of the cart.

cart_items - [ConfigurableProductCartItemInput]!

(BETA) An array of configurable products to add.

Example
{
  "cart_id": "xyz789",
  "cart_items": [ConfigurableProductCartItemInput]
}

AddConfigurableProductsToCartOutput

Description

(BETA) Contains details about the cart after adding configurable products.

Fields
Field Name Description
cart - Cart! (BETA) The cart after adding products.
Example
{"cart": Cart}

AddDownloadableProductsToCartInput

Fields
Input Field Description
cart_id - String!

(BETA) The ID of the cart.

cart_items - [DownloadableProductCartItemInput]!

(BETA) An array of downloadable products to add.

Example
{
  "cart_id": "xyz789",
  "cart_items": [DownloadableProductCartItemInput]
}

AddDownloadableProductsToCartOutput

Description

(BETA) Contains details about the cart after adding downloadable products.

Fields
Field Name Description
cart - Cart! (BETA) The cart after adding products.
Example
{"cart": Cart}

AddGiftRegistryRegistrantInput

Description

(BETA) Defines a new registrant.

Fields
Input Field Description
dynamic_attributes - [GiftRegistryDynamicAttributeInput]

(BETA) Additional attributes specified as a code-value pair.

email - String!

(BETA) The email address of the registrant.

firstname - String!

(BETA) The first name of the registrant.

lastname - String!

(BETA) The last name of the registrant.

Example
{
  "dynamic_attributes": [
    GiftRegistryDynamicAttributeInput
  ],
  "email": "abc123",
  "firstname": "xyz789",
  "lastname": "abc123"
}

AddGiftRegistryRegistrantsOutput

Description

(BETA) Contains the results of a request to add registrants.

Fields
Field Name Description
gift_registry - GiftRegistry (BETA) The gift registry after adding registrants.
Example
{"gift_registry": GiftRegistry}

AddProductsToCartOutput

Description

(BETA) Contains details about the cart after adding products to it.

Fields
Field Name Description
cart - Cart! (BETA) The cart after products have been added.
user_errors - [CartUserInputError]! (BETA) Contains errors encountered while adding an item to the cart.
Example
{
  "cart": Cart,
  "user_errors": [CartUserInputError]
}

AddProductsToCompareListInput

Description

(BETA) Contains products to add to an existing compare list.

Fields
Input Field Description
products - [ID]!

(BETA) An array of product IDs to add to the compare list.

uid - ID!

(BETA) The unique identifier of the compare list to modify.

Example
{
  "products": ["4"],
  "uid": "4"
}

AddProductsToRequisitionListOutput

Description

(BETA) Output of the request to add products to a requisition list.

Fields
Field Name Description
requisition_list - RequisitionList (BETA) The requisition list after adding products.
Example
{"requisition_list": RequisitionList}

AddProductsToWishlistOutput

Description

(BETA) Contains the customer's wish list and any errors encountered.

Fields
Field Name Description
user_errors - [WishListUserInputError]! (BETA) An array of errors encountered while adding products to a wish list.
wishlist - Wishlist! (BETA) Contains the wish list with all items that were successfully added.
Example
{
  "user_errors": [WishListUserInputError],
  "wishlist": Wishlist
}

AddPurchaseOrderCommentInput

Description

(BETA) Contains the comment to be added to a purchase order.

Fields
Input Field Description
comment - String!

(BETA) Comment text.

purchase_order_uid - ID!

(BETA) The unique ID of a purchase order.

Example
{
  "comment": "abc123",
  "purchase_order_uid": 4
}

AddPurchaseOrderCommentOutput

Description

(BETA) Contains the successfully added comment.

Fields
Field Name Description
comment - PurchaseOrderComment! (BETA) The purchase order comment.
Example
{"comment": PurchaseOrderComment}

AddPurchaseOrderItemsToCartInput

Description

(BETA) Defines the purchase order and cart to act on.

Fields
Input Field Description
cart_id - String!

(BETA) The ID to assign to the cart.

purchase_order_uid - ID!

(BETA) Purchase order unique ID.

replace_existing_cart_items - Boolean!

(BETA) Replace existing cart or merge items.

Example
{
  "cart_id": "abc123",
  "purchase_order_uid": "4",
  "replace_existing_cart_items": false
}

AddRequisitionListItemToCartUserError

Description

(BETA) Contains details about why an attempt to add items to the requistion list failed.

Fields
Field Name Description
message - String! (BETA) A description of the error.
type - AddRequisitionListItemToCartUserErrorType! (BETA) The type of error that occurred.
Example
{
  "message": "xyz789",
  "type": "OUT_OF_STOCK"
}

AddRequisitionListItemToCartUserErrorType

Values
Enum Value Description

OUT_OF_STOCK

UNAVAILABLE_SKU

OPTIONS_UPDATED

LOW_QUANTITY

Example
"OUT_OF_STOCK"

AddRequisitionListItemsToCartOutput

Description

(BETA) Output of the request to add items in a requisition list to the cart.

Fields
Field Name Description
add_requisition_list_items_to_cart_user_errors - [AddRequisitionListItemToCartUserError]! (BETA) Details about why the attempt to add items to the requistion list was not successful.
cart - Cart (BETA) The cart after adding requisition list items.
status - Boolean! (BETA) Indicates whether the attempt to add items to the requisition list was successful.
Example
{
  "add_requisition_list_items_to_cart_user_errors": [
    AddRequisitionListItemToCartUserError
  ],
  "cart": Cart,
  "status": true
}

AddReturnCommentInput

Description

(BETA) Defines a return comment.

Fields
Input Field Description
comment_text - String!

(BETA) The text added to the return request.

return_uid - ID!

(BETA) The unique ID for a Return object.

Example
{
  "comment_text": "abc123",
  "return_uid": "4"
}

AddReturnCommentOutput

Description

(BETA) Contains details about the return request.

Fields
Field Name Description
return - Return (BETA) The modified return.
Example
{"return": Return}

AddReturnTrackingInput

Description

(BETA) Defines tracking information to be added to the return.

Fields
Input Field Description
carrier_uid - ID!

(BETA) The unique ID for a ReturnShippingCarrier object.

return_uid - ID!

(BETA) The unique ID for a Returns object.

tracking_number - String!

(BETA) The shipping tracking number for this return request.

Example
{
  "carrier_uid": 4,
  "return_uid": "4",
  "tracking_number": "xyz789"
}

AddReturnTrackingOutput

Description

(BETA) Contains the response after adding tracking information.

Fields
Field Name Description
return - Return (BETA) Details about the modified return.
return_shipping_tracking - ReturnShippingTracking (BETA) Details about shipping for a return.
Example
{
  "return": Return,
  "return_shipping_tracking": ReturnShippingTracking
}

AddSimpleProductsToCartInput

Description

(BETA) Defines the simple and group products to add to the cart.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID of a Cart object.

cart_items - [SimpleProductCartItemInput]!

(BETA) An array of simple and group items to add.

Example
{
  "cart_id": "abc123",
  "cart_items": [SimpleProductCartItemInput]
}

AddSimpleProductsToCartOutput

Description

(BETA) Contains details about the cart after adding simple or group products.

Fields
Field Name Description
cart - Cart! (BETA) The cart after adding products.
Example
{"cart": Cart}

AddVirtualProductsToCartInput

Description

(BETA) Defines the virtual products to add to the cart.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID of a Cart object.

cart_items - [VirtualProductCartItemInput]!

(BETA) An array of virtual products to add.

Example
{
  "cart_id": "abc123",
  "cart_items": [VirtualProductCartItemInput]
}

AddVirtualProductsToCartOutput

Description

(BETA) Contains details about the cart after adding virtual products.

Fields
Field Name Description
cart - Cart! (BETA) The cart after adding products.
Example
{"cart": Cart}

AddWishlistItemsToCartOutput

Description

(BETA) Contains the resultant wish list and any error information.

Fields
Field Name Description
add_wishlist_items_to_cart_user_errors - [WishlistCartUserInputError]! (BETA) An array of errors encountered while adding products to the customer's cart.
status - Boolean! (BETA) Indicates whether the attempt to add items to the customer's cart was successful.
wishlist - Wishlist! (BETA) Contains the wish list with all items that were successfully added.
Example
{
  "add_wishlist_items_to_cart_user_errors": [
    WishlistCartUserInputError
  ],
  "status": false,
  "wishlist": Wishlist
}

Aggregation

Description

(BETA) Contains information for each filterable option (such as price, category UID, and custom attributes).

Fields
Field Name Description
attribute_code - String! (BETA) Attribute code of the aggregation group.
count - Int (BETA) The number of options in the aggregation group.
label - String (BETA) The aggregation display name.
options - [AggregationOption] (BETA) Array of options for the aggregation.
position - Int (BETA) The relative position of the attribute in a layered navigation block.
Example
{
  "attribute_code": "abc123",
  "count": 987,
  "label": "abc123",
  "options": [AggregationOption],
  "position": 123
}

AggregationOption

Description

(BETA) An implementation of AggregationOptionInterface.

Fields
Field Name Description
count - Int (BETA) The number of items that match the aggregation option.
label - String (BETA) The display label for an aggregation option.
value - String! (BETA) The internal ID that represents the value of the option.
Example
{
  "count": 987,
  "label": "xyz789",
  "value": "xyz789"
}

AggregationOptionInterface

Description

(BETA) Defines aggregation option fields.

Fields
Field Name Description
count - Int (BETA) The number of items that match the aggregation option.
label - String (BETA) The display label for an aggregation option.
value - String! (BETA) The internal ID that represents the value of the option.
Possible Types
AggregationOptionInterface Types

AggregationOption

Example
{
  "count": 123,
  "label": "abc123",
  "value": "abc123"
}

AggregationsCategoryFilterInput

Description

(BETA) Filter category aggregations in layered navigation.

Fields
Input Field Description
includeDirectChildrenOnly - Boolean

(BETA) Indicates whether to include only direct subcategories or all children categories at all levels.

Example
{"includeDirectChildrenOnly": true}

AggregationsFilterInput

Description

(BETA) An input object that specifies the filters used in product aggregations.

Fields
Input Field Description
category - AggregationsCategoryFilterInput

(BETA) Filter category aggregations in layered navigation.

Example
{"category": AggregationsCategoryFilterInput}

AppliedCoupon

Description

(BETA) Contains the applied coupon code.

Fields
Field Name Description
code - String! (BETA) The coupon code the shopper applied to the card.
Example
{"code": "abc123"}

AppliedGiftCard

Description

(BETA) Contains an applied gift card with applied and remaining balance.

Fields
Field Name Description
applied_balance - Money (BETA) The amount applied to the current cart.
code - String (BETA) The gift card account code.
current_balance - Money (BETA) The remaining balance on the gift card.
expiration_date - String (BETA) The expiration date of the gift card.
Example
{
  "applied_balance": Money,
  "code": "abc123",
  "current_balance": Money,
  "expiration_date": "xyz789"
}

AppliedStoreCredit

Description

(BETA) Contains the applied and current balances.

Fields
Field Name Description
applied_balance - Money (BETA) The applied store credit balance to the current cart.
current_balance - Money (BETA) The current balance remaining on store credit.
enabled - Boolean (BETA) Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned.
Example
{
  "applied_balance": Money,
  "current_balance": Money,
  "enabled": true
}

ApplyCouponToCartInput

Description

(BETA) Specifies the coupon code to apply to the cart.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID of a Cart object.

coupon_code - String!

(BETA) A valid coupon code.

Example
{
  "cart_id": "xyz789",
  "coupon_code": "abc123"
}

ApplyCouponToCartOutput

Description

(BETA) Contains details about the cart after applying a coupon.

Fields
Field Name Description
cart - Cart! (BETA) The cart after applying a coupon.
Example
{"cart": Cart}

ApplyGiftCardToCartInput

Description

(BETA) Defines the input required to run the applyGiftCardToCart mutation.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID that identifies the customer's cart.

gift_card_code - String!

(BETA) The gift card code to be applied to the cart.

Example
{
  "cart_id": "abc123",
  "gift_card_code": "xyz789"
}

ApplyGiftCardToCartOutput

Description

(BETA) Defines the possible output for the applyGiftCardToCart mutation.

Fields
Field Name Description
cart - Cart! (BETA) Describes the contents of the specified shopping cart.
Example
{"cart": Cart}

ApplyRewardPointsToCartOutput

Description

(BETA) Contains the customer cart.

Fields
Field Name Description
cart - Cart! (BETA) The customer cart after reward points are applied.
Example
{"cart": Cart}

ApplyStoreCreditToCartInput

Description

(BETA) Defines the input required to run the applyStoreCreditToCart mutation.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID that identifies the customer's cart.

Example
{"cart_id": "abc123"}

ApplyStoreCreditToCartOutput

Description

(BETA) Defines the possible output for the applyStoreCreditToCart mutation.

Fields
Field Name Description
cart - Cart! (BETA) The contents of the specified shopping cart.
Example
{"cart": Cart}

AreaInput

Description

(BETA) AreaInput defines the parameters which will be used for filter by specified location.

Fields
Input Field Description
radius - Int!

(BETA) The radius for the search in KM.

search_term - String!

(BETA) The country code where search must be performed. Required parameter together with region, city or postcode.

Example
{"radius": 987, "search_term": "xyz789"}

AssignCompareListToCustomerOutput

Description

(BETA) Contains the results of the request to assign a compare list.

Fields
Field Name Description
compare_list - CompareList (BETA) The contents of the customer's compare list.
result - Boolean! (BETA) Indicates whether the compare list was successfully assigned to the customer.
Example
{"compare_list": CompareList, "result": true}

Attribute

Description

(BETA) Contains details about the attribute, including the code and type.

Fields
Field Name Description
attribute_code - String (BETA) The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
attribute_options - [AttributeOption] (BETA) Attribute options list.
attribute_type - String (BETA) The data type of the attribute.
entity_type - String (BETA) The type of entity that defines the attribute.
input_type - String (BETA) The frontend input type of the attribute.
storefront_properties - StorefrontProperties (BETA) Details about the storefront properties configured for the attribute.
Example
{
  "attribute_code": "xyz789",
  "attribute_options": [AttributeOption],
  "attribute_type": "abc123",
  "entity_type": "abc123",
  "input_type": "abc123",
  "storefront_properties": StorefrontProperties
}

AttributeInput

Description

(BETA) Defines the attribute characteristics to search for the attribute_code and entity_type to search.

Fields
Input Field Description
attribute_code - String

(BETA) The unique identifier for an attribute code. This value should be in lowercase letters without spaces.

entity_type - String

(BETA) The type of entity that defines the attribute.

Example
{
  "attribute_code": "xyz789",
  "entity_type": "xyz789"
}

AttributeOption

Description

(BETA) Defines an attribute option.

Fields
Field Name Description
label - String (BETA) The label assigned to the attribute option.
value - String (BETA) The attribute option value.
Example
{
  "label": "xyz789",
  "value": "abc123"
}

AvailableCurrency

Description

(BETA) Defines the code and symbol of a currency that can be used for purchase orders.

Fields
Field Name Description
code - CurrencyEnum! (BETA) 3-letter currency code, for example USD.
symbol - String! (BETA) Currency symbol, for example $.
Example
{"code": "AFN", "symbol": "abc123"}

AvailablePaymentMethod

Description

(BETA) Describes a payment method that the shopper can use to pay for the order.

Fields
Field Name Description
code - String! (BETA) The payment method code.
is_deferred - Boolean! (BETA) If the payment method is an online integration
title - String! (BETA) The payment method title.
Example
{
  "code": "abc123",
  "is_deferred": false,
  "title": "abc123"
}

AvailableShippingMethod

Description

(BETA) Contains details about the possible shipping methods and carriers.

Fields
Field Name Description
amount - Money! (BETA) The cost of shipping using this shipping method.
available - Boolean! (BETA) Indicates whether this shipping method can be applied to the cart.
base_amount - Money The field should not be used on the storefront.
carrier_code - String! (BETA) A string that identifies a commercial carrier or an offline shipping method.
carrier_title - String! (BETA) The label for the carrier code.
error_message - String (BETA) Describes an error condition.
method_code - String (BETA) A shipping method code associated with a carrier. The value could be null if no method is available.
method_title - String (BETA) The label for the shipping method code. The value could be null if no method is available.
price_excl_tax - Money! (BETA) The cost of shipping using this shipping method, excluding tax.
price_incl_tax - Money! (BETA) The cost of shipping using this shipping method, including tax.
Example
{
  "amount": Money,
  "available": true,
  "base_amount": Money,
  "carrier_code": "xyz789",
  "carrier_title": "abc123",
  "error_message": "abc123",
  "method_code": "abc123",
  "method_title": "xyz789",
  "price_excl_tax": Money,
  "price_incl_tax": Money
}

BatchMutationStatus

Values
Enum Value Description

SUCCESS

FAILURE

MIXED_RESULTS

Example
"SUCCESS"

BillingAddressInput

Description

(BETA) Defines the billing address.

Fields
Input Field Description
address - CartAddressInput

(BETA) Defines a billing address.

customer_address_id - Int

(BETA) An ID from the customer's address book that uniquely identifies the address to be used for billing.

same_as_shipping - Boolean

(BETA) Indicates whether to set the billing address to be the same as the existing shipping address on the cart.

use_for_shipping - Boolean

(BETA) Indicates whether to set the shipping address to be the same as this billing address.

Example
{
  "address": CartAddressInput,
  "customer_address_id": 987,
  "same_as_shipping": true,
  "use_for_shipping": true
}

BillingCartAddress

Description

(BETA) Contains details about the billing address.

Fields
Field Name Description
city - String! (BETA) The city specified for the billing or shipping address.
company - String (BETA) The company specified for the billing or shipping address.
country - CartAddressCountry! (BETA) An object containing the country label and code.
customer_notes - String The field is used only in shipping address.
firstname - String! (BETA) The first name of the customer or guest.
lastname - String! (BETA) The last name of the customer or guest.
postcode - String (BETA) The ZIP or postal code of the billing or shipping address.
region - CartAddressRegion (BETA) An object containing the region label and code.
street - [String]! (BETA) An array containing the street for the billing or shipping address.
telephone - String (BETA) The telephone number for the billing or shipping address.
uid - String! (BETA) The unique id of the customer address.
vat_id - String (BETA) The VAT company number for billing or shipping address.
Example
{
  "city": "abc123",
  "company": "abc123",
  "country": CartAddressCountry,
  "customer_notes": "abc123",
  "firstname": "abc123",
  "lastname": "abc123",
  "postcode": "abc123",
  "region": CartAddressRegion,
  "street": ["abc123"],
  "telephone": "abc123",
  "uid": "xyz789",
  "vat_id": "xyz789"
}

Boolean

Description

(BETA) The Boolean scalar type represents true or false.

Example
true

BraintreeCcVaultInput

Fields
Input Field Description
device_data - String
public_hash - String!
Example
{
  "device_data": "xyz789",
  "public_hash": "abc123"
}

BraintreeInput

Fields
Input Field Description
device_data - String

(BETA) Contains a fingerprint provided by Braintree JS SDK and should be sent with sale transaction details to the Braintree payment gateway.

is_active_payment_token_enabler - Boolean!

(BETA) States whether an entered by a customer credit/debit card should be tokenized for later usage. Required only if Vault is enabled for Braintree payment integration.

payment_method_nonce - String!

(BETA) The one-time payment token generated by Braintree payment gateway based on card details. Required field to make sale transaction.

Example
{
  "device_data": "abc123",
  "is_active_payment_token_enabler": true,
  "payment_method_nonce": "abc123"
}

Breadcrumb

Description

(BETA) Contains details about an individual category that comprises a breadcrumb.

Fields
Field Name Description
category_id - Int (BETA) The ID of the category. Use category_uid instead.
category_level - Int (BETA) The category level.
category_name - String (BETA) The display name of the category.
category_uid - ID! (BETA) The unique ID for a Breadcrumb object.
category_url_key - String (BETA) The URL key of the category.
category_url_path - String (BETA) The URL path of the category.
Example
{
  "category_id": 987,
  "category_level": 987,
  "category_name": "abc123",
  "category_uid": "4",
  "category_url_key": "xyz789",
  "category_url_path": "abc123"
}

BundleCartItem

Description

(BETA) An implementation for bundle product cart items.

Fields
Field Name Description
available_gift_wrapping - [GiftWrapping]! (BETA) The list of available gift wrapping options for the cart item.
bundle_options - [SelectedBundleOption]! (BETA) An array containing the bundle options the shopper selected.
customizable_options - [SelectedCustomizableOption]! (BETA) An array containing the customizable options the shopper selected.
errors - [CartItemError] (BETA) An array of errors encountered while loading the cart item
gift_message - GiftMessage (BETA) The entered gift message for the cart item
gift_wrapping - GiftWrapping (BETA) The selected gift wrapping for the cart item.
id - String! Use uid instead.
prices - CartItemPrices (BETA) Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! (BETA) Details about an item in the cart.
quantity - Float! (BETA) The quantity of this item in the cart.
uid - ID! (BETA) The unique ID for a CartItemInterface object.
Example
{
  "available_gift_wrapping": [GiftWrapping],
  "bundle_options": [SelectedBundleOption],
  "customizable_options": [SelectedCustomizableOption],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "abc123",
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 987.65,
  "uid": "4"
}

BundleCreditMemoItem

Description

(BETA) Defines bundle product options for CreditMemoItemInterface.

Fields
Field Name Description
bundle_options - [ItemSelectedBundleOption] (BETA) A list of bundle options that are assigned to a bundle product that is part of a credit memo.
discounts - [Discount] (BETA) Details about the final discount amount for the base product, including discounts on options.
id - ID! (BETA) The unique ID for a CreditMemoItemInterface object.
order_item - OrderItemInterface (BETA) The order item the credit memo is applied to.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product, including selected options.
product_sku - String! (BETA) The SKU of the base product.
quantity_refunded - Float (BETA) The number of refunded items.
Example
{
  "bundle_options": [ItemSelectedBundleOption],
  "discounts": [Discount],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_refunded": 123.45
}

BundleInvoiceItem

Description

(BETA) Defines bundle product options for InvoiceItemInterface.

Fields
Field Name Description
bundle_options - [ItemSelectedBundleOption] (BETA) A list of bundle options that are assigned to an invoiced bundle product.
discounts - [Discount] (BETA) Information about the final discount amount for the base product, including discounts on options.
id - ID! (BETA) The unique ID for an InvoiceItemInterface object.
order_item - OrderItemInterface (BETA) Details about an individual order item.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product including selected options.
product_sku - String! (BETA) The SKU of the base product.
quantity_invoiced - Float (BETA) The number of invoiced items.
Example
{
  "bundle_options": [ItemSelectedBundleOption],
  "discounts": [Discount],
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_invoiced": 123.45
}

BundleItem

Description

(BETA) Defines an individual item within a bundle product.

Fields
Field Name Description
option_id - Int (BETA) An ID assigned to each type of item in a bundle product. Use uid instead
options - [BundleItemOption] (BETA) An array of additional options for this bundle item.
position - Int (BETA) A number indicating the sequence order of this item compared to the other bundle items.
price_range - PriceRange! (BETA) The range of prices for the product
required - Boolean (BETA) Indicates whether the item must be included in the bundle.
sku - String (BETA) The SKU of the bundle product.
title - String (BETA) The display name of the item.
type - String (BETA) The input type that the customer uses to select the item. Examples include radio button and checkbox.
uid - ID (BETA) The unique ID for a BundleItem object.
Example
{
  "option_id": 987,
  "options": [BundleItemOption],
  "position": 987,
  "price_range": PriceRange,
  "required": true,
  "sku": "xyz789",
  "title": "abc123",
  "type": "xyz789",
  "uid": 4
}

BundleItemOption

Description

(BETA) Defines the characteristics that comprise a specific bundle item and its options.

Fields
Field Name Description
can_change_quantity - Boolean (BETA) Indicates whether the customer can change the number of items for this option.
id - Int (BETA) The ID assigned to the bundled item option. Use uid instead
is_default - Boolean (BETA) Indicates whether this option is the default option.
label - String (BETA) The text that identifies the bundled item option.
position - Int (BETA) When a bundle item contains multiple options, the relative position of this option compared to the other options.
price - Float (BETA) The price of the selected option.
price_type - PriceTypeEnum (BETA) One of FIXED, PERCENT, or DYNAMIC.
product - ProductInterface (BETA) Contains details about this product option.
qty - Float (BETA) Indicates the quantity of this specific bundle item. Use quantity instead.
quantity - Float (BETA) The quantity of this specific bundle item.
uid - ID! (BETA) The unique ID for a BundleItemOption object.
Example
{
  "can_change_quantity": false,
  "id": 123,
  "is_default": false,
  "label": "abc123",
  "position": 123,
  "price": 987.65,
  "price_type": "FIXED",
  "product": ProductInterface,
  "qty": 123.45,
  "quantity": 987.65,
  "uid": 4
}

BundleOptionInput

Description

(BETA) Defines the input for a bundle option.

Fields
Input Field Description
id - Int!

(BETA) The ID of the option.

quantity - Float!

(BETA) The number of the selected item to add to the cart.

value - [String]!

(BETA) An array with the chosen value of the option.

Example
{
  "id": 123,
  "quantity": 123.45,
  "value": ["xyz789"]
}

BundleOrderItem

Description

(BETA) Defines bundle product options for OrderItemInterface.

Fields
Field Name Description
bundle_options - [ItemSelectedBundleOption] (BETA) A list of bundle options that are assigned to the bundle product.
discounts - [Discount] (BETA) The final discount information for the product.
eligible_for_return - Boolean (BETA) Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption] (BETA) The entered option for the base product, such as a logo or image.
gift_message - GiftMessage (BETA) The selected gift message for the order item
gift_wrapping - GiftWrapping (BETA) The selected gift wrapping for the order item.
id - ID! (BETA) The unique ID for an OrderItemInterface object.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price of the base product, including selected options.
product_sku - String! (BETA) The SKU of the base product.
product_type - String (BETA) The type of product, such as simple, configurable, etc.
product_url_key - String (BETA) URL key of the base product.
quantity_canceled - Float (BETA) The number of canceled items.
quantity_invoiced - Float (BETA) The number of invoiced items.
quantity_ordered - Float (BETA) The number of units ordered for this item.
quantity_refunded - Float (BETA) The number of refunded items.
quantity_returned - Float (BETA) The number of returned items.
quantity_shipped - Float (BETA) The number of shipped items.
selected_options - [OrderItemOption] (BETA) The selected options for the base product, such as color or size.
status - String (BETA) The status of the order item.
Example
{
  "bundle_options": [ItemSelectedBundleOption],
  "discounts": [Discount],
  "eligible_for_return": false,
  "entered_options": [OrderItemOption],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "4",
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "product_type": "xyz789",
  "product_url_key": "xyz789",
  "quantity_canceled": 987.65,
  "quantity_invoiced": 987.65,
  "quantity_ordered": 123.45,
  "quantity_refunded": 987.65,
  "quantity_returned": 987.65,
  "quantity_shipped": 123.45,
  "selected_options": [OrderItemOption],
  "status": "abc123"
}

BundleProduct

Description

(BETA) Defines basic features of a bundle product and contains multiple BundleItems.

Fields
Field Name Description
activity - String Use the custom_attributes field instead.
attribute_set_id - Int (BETA) The attribute set assigned to the product. The field should not be used on the storefront.
canonical_url - String (BETA) The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] (BETA) The categories assigned to a product.
category_gear - String Use the custom_attributes field instead.
climate - String Use the custom_attributes field instead.
collar - String Use the custom_attributes field instead.
color - Int Use the custom_attributes field instead.
country_of_manufacture - String (BETA) The product's country of origin.
created_at - String (BETA) Timestamp indicating when the product was created. The field should not be used on the storefront.
crosssell_products - [ProductInterface] (BETA) An array of cross-sell products.
description - ComplexTextValue (BETA) Detailed information about the product. The value can include simple HTML tags.
dynamic_price - Boolean (BETA) Indicates whether the bundle product has a dynamic price.
dynamic_sku - Boolean (BETA) Indicates whether the bundle product has a dynamic SKU.
dynamic_weight - Boolean (BETA) Indicates whether the bundle product has a dynamically calculated weight.
eco_collection - Int Use the custom_attributes field instead.
erin_recommends - Int Use the custom_attributes field instead.
features_bags - String Use the custom_attributes field instead.
format - Int Use the custom_attributes field instead.
gender - String Use the custom_attributes field instead.
gift_message_available - String (BETA) Indicates whether a gift message is available.
id - Int (BETA) The ID number assigned to the product. Use the uid field instead.
image - ProductImage (BETA) The relative path to the main image on the product page.
is_returnable - String (BETA) Indicates whether the product can be returned.
items - [BundleItem] (BETA) An array containing information about individual bundle items.
manufacturer - Int (BETA) A number representing the product's manufacturer. Use the custom_attributes field instead.
material - String Use the custom_attributes field instead.
media_gallery - [MediaGalleryInterface] (BETA) An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] (BETA) An array of MediaGalleryEntry objects. Use media_gallery instead.
meta_description - String (BETA) A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String (BETA) A comma-separated list of keywords that are visible only to search engines.
meta_title - String (BETA) A string that is displayed in the title bar and tab of the browser and in search results lists.
name - String (BETA) The product name. Customers use this name to identify the product.
new - Int Use the custom_attributes field instead.
new_from_date - String (BETA) The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String (BETA) The end date for new product listings.
only_x_left_in_stock - Float (BETA) Product stock only x left count
options - [CustomizableOptionInterface] (BETA) An array of options for a customizable product.
options_container - String (BETA) If the product has multiple options, determines where they appear on the product page.
pattern - String Use the custom_attributes field instead.
performance_fabric - Int Use the custom_attributes field instead.
price - ProductPrices (BETA) Indicates the price of an item. Use price_range for product price information.
price_range - PriceRange! (BETA) The range of prices for the product
price_tiers - [TierPrice] (BETA) An array of TierPrice objects.
price_view - PriceViewEnum (BETA) One of PRICE_RANGE or AS_LOW_AS.
product_links - [ProductLinksInterface] (BETA) An array of ProductLinks objects.
purpose - Int Use the custom_attributes field instead.
rating_summary - Float! (BETA) The average of all the ratings given to the product.
redirect_code - Int! (BETA) Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] (BETA) An array of related products.
relative_url - String (BETA) The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! (BETA) The total count of all the reviews given to the product.
reviews - ProductReviews! (BETA) The list of products reviews.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default is 20.

currentPage - Int

(BETA) The page of results to return. The default is 1.

sale - Int Use the custom_attributes field instead.
ship_bundle_items - ShipBundleItemsEnum (BETA) Indicates whether to ship bundle items together or individually.
short_description - ComplexTextValue (BETA) A short description of the product. Its use depends on the theme.
size - Int Use the custom_attributes field instead.
sku - String (BETA) A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String Use the custom_attributes field instead.
small_image - ProductImage (BETA) The relative path to the small image, which is used on catalog pages.
special_from_date - String (BETA) The beginning date that a product has a special price. The field should not be used on the storefront.
special_price - Float (BETA) The discounted price of the product.
special_to_date - String (BETA) The end date for a product with a special price.
staged - Boolean! (BETA) Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus (BETA) Stock status of the product
strap_bags - String Use the custom_attributes field instead.
style_bags - String Use the custom_attributes field instead.
style_bottom - String Use the custom_attributes field instead.
style_general - String Use the custom_attributes field instead.
swatch_image - String (BETA) The file name of a swatch image.
thumbnail - ProductImage (BETA) The relative path to the product's thumbnail image.
tier_price - Float (BETA) The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information.
tier_prices - [ProductTierPrices] (BETA) An array of ProductTierPrices objects. Use price_tiers for product tier price information.
type - UrlRewriteEntityTypeEnum (BETA) One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String (BETA) One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead.
uid - ID! (BETA) The unique ID for a ProductInterface object.
updated_at - String (BETA) Timestamp indicating when the product was updated. The field should not be used on the storefront.
upsell_products - [ProductInterface] (BETA) An array of up-sell products.
url_key - String (BETA) The part of the URL that identifies the product
url_path - String Use product's canonical_url or url rewrites instead
url_rewrites - [UrlRewrite] (BETA) URL rewrites list
url_suffix - String (BETA) The part of the product URL that is appended after the url key
websites - [Website] (BETA) An array of websites in which the product is available. The field should not be used on the storefront.
weight - Float (BETA) The weight of the item, in units defined by the store.
Example
{
  "activity": "xyz789",
  "attribute_set_id": 987,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "category_gear": "xyz789",
  "climate": "xyz789",
  "collar": "xyz789",
  "color": 123,
  "country_of_manufacture": "abc123",
  "created_at": "abc123",
  "crosssell_products": [ProductInterface],
  "description": ComplexTextValue,
  "dynamic_price": true,
  "dynamic_sku": true,
  "dynamic_weight": false,
  "eco_collection": 987,
  "erin_recommends": 987,
  "features_bags": "xyz789",
  "format": 987,
  "gender": "abc123",
  "gift_message_available": "xyz789",
  "id": 123,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "items": [BundleItem],
  "manufacturer": 123,
  "material": "abc123",
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "abc123",
  "name": "abc123",
  "new": 123,
  "new_from_date": "abc123",
  "new_to_date": "xyz789",
  "only_x_left_in_stock": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "xyz789",
  "pattern": "abc123",
  "performance_fabric": 123,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "price_view": "PRICE_RANGE",
  "product_links": [ProductLinksInterface],
  "purpose": 123,
  "rating_summary": 987.65,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 123,
  "reviews": ProductReviews,
  "sale": 987,
  "ship_bundle_items": "TOGETHER",
  "short_description": ComplexTextValue,
  "size": 987,
  "sku": "xyz789",
  "sleeve": "abc123",
  "small_image": ProductImage,
  "special_from_date": "xyz789",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": false,
  "stock_status": "IN_STOCK",
  "strap_bags": "xyz789",
  "style_bags": "xyz789",
  "style_bottom": "abc123",
  "style_general": "xyz789",
  "swatch_image": "abc123",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "xyz789",
  "uid": "4",
  "updated_at": "abc123",
  "upsell_products": [ProductInterface],
  "url_key": "xyz789",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website],
  "weight": 123.45
}

BundleProductCartItemInput

Description

(BETA) Defines a single bundle product.

Fields
Input Field Description
bundle_options - [BundleOptionInput]!

(BETA) A mandatory array of options for the bundle product, including each chosen option and specified quantity.

customizable_options - [CustomizableOptionInput]

(BETA) The ID and value of the option.

data - CartItemInput!

(BETA) The quantity and SKU of the bundle product.

Example
{
  "bundle_options": [BundleOptionInput],
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput
}

BundleRequisitionListItem

Description

(BETA) Contains details about bundle products added to a requisition list.

Fields
Field Name Description
bundle_options - [SelectedBundleOption]! (BETA) An array of selected options for a bundle product.
customizable_options - [SelectedCustomizableOption]! (BETA) Selected custom options for an item in the requisition list.
product - ProductInterface! (BETA) Details about a requisition list item.
quantity - Float! (BETA) The quantity of the product added to the requisition list.
uid - ID! (BETA) The unique ID of an item in a requisition list.
Example
{
  "bundle_options": [SelectedBundleOption],
  "customizable_options": [SelectedCustomizableOption],
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": "4"
}

BundleShipmentItem

Description

(BETA) Defines bundle product options for ShipmentItemInterface.

Fields
Field Name Description
bundle_options - [ItemSelectedBundleOption] (BETA) A list of bundle options that are assigned to a shipped product.
id - ID! (BETA) The unique ID for a ShipmentItemInterface object.
order_item - OrderItemInterface (BETA) The order item associated with the shipment item.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product.
product_sku - String! (BETA) The SKU of the base product.
quantity_shipped - Float! (BETA) The number of shipped items.
Example
{
  "bundle_options": [ItemSelectedBundleOption],
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_shipped": 123.45
}

BundleWishlistItem

Description

(BETA) Defines bundle product options for WishlistItemInterface.

Fields
Field Name Description
added_at - String! (BETA) The date and time the item was added to the wish list.
bundle_options - [SelectedBundleOption] (BETA) An array containing information about the selected bundle items.
customizable_options - [SelectedCustomizableOption]! (BETA) Custom options selected for the wish list item.
description - String (BETA) The description of the item.
id - ID! (BETA) The unique ID for a WishlistItemInterface object.
product - ProductInterface (BETA) Product details of the wish list item.
quantity - Float! (BETA) The quantity of this wish list item.
Example
{
  "added_at": "abc123",
  "bundle_options": [SelectedBundleOption],
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "id": "4",
  "product": ProductInterface,
  "quantity": 123.45
}

Cart

Description

(BETA) Contains the contents and other details about a guest or customer cart.

Fields
Field Name Description
applied_coupon - AppliedCoupon Use applied_coupons instead.
applied_coupons - [AppliedCoupon] (BETA) An array of AppliedCoupon objects. Each object contains the code text attribute, which specifies the coupon code.
applied_gift_cards - [AppliedGiftCard] (BETA) An array of gift card items applied to the cart.
applied_reward_points - RewardPointsAmount (BETA) The amount of reward points applied to the cart.
applied_store_credit - AppliedStoreCredit (BETA) Store credit information applied to the cart.
available_gift_wrappings - [GiftWrapping]! (BETA) The list of available gift wrapping options for the cart.
available_payment_methods - [AvailablePaymentMethod] (BETA) An array of available payment methods.
billing_address - BillingCartAddress (BETA) The billing address assigned to the cart.
email - String (BETA) The email address of the guest or customer.
gift_message - GiftMessage (BETA) The entered gift message for the cart
gift_receipt_included - Boolean! (BETA) Indicates whether the shopper requested gift receipt for the cart.
gift_wrapping - GiftWrapping (BETA) The selected gift wrapping for the cart.
id - ID! (BETA) The unique ID for a Cart object.
is_virtual - Boolean! (BETA) Indicates whether the cart contains only virtual products.
items - [CartItemInterface] (BETA) An array of products that have been added to the cart.
prices - CartPrices (BETA) Pricing details for the quote.
printed_card_included - Boolean! (BETA) Indicates whether the shopper requested a printed card for the cart.
selected_payment_method - SelectedPaymentMethod (BETA) Indicates which payment method was applied to the cart.
shipping_addresses - [ShippingCartAddress]! (BETA) An array of shipping addresses assigned to the cart.
total_quantity - Float! (BETA) The total number of items in the cart.
Example
{
  "applied_coupon": AppliedCoupon,
  "applied_coupons": [AppliedCoupon],
  "applied_gift_cards": [AppliedGiftCard],
  "applied_reward_points": RewardPointsAmount,
  "applied_store_credit": AppliedStoreCredit,
  "available_gift_wrappings": [GiftWrapping],
  "available_payment_methods": [AvailablePaymentMethod],
  "billing_address": BillingCartAddress,
  "email": "abc123",
  "gift_message": GiftMessage,
  "gift_receipt_included": true,
  "gift_wrapping": GiftWrapping,
  "id": 4,
  "is_virtual": true,
  "items": [CartItemInterface],
  "prices": CartPrices,
  "printed_card_included": true,
  "selected_payment_method": SelectedPaymentMethod,
  "shipping_addresses": [ShippingCartAddress],
  "total_quantity": 123.45
}

CartAddressCountry

Description

(BETA) Contains details the country in a billing or shipping address.

Fields
Field Name Description
code - String! (BETA) The country code.
label - String! (BETA) The display label for the country.
Example
{
  "code": "abc123",
  "label": "abc123"
}

CartAddressInput

Description

(BETA) Defines the billing or shipping address to be applied to the cart.

Fields
Input Field Description
city - String!

(BETA) The city specified for the billing or shipping address.

company - String

(BETA) The company specified for the billing or shipping address.

country_code - String!

(BETA) The country code and label for the billing or shipping address.

firstname - String!

(BETA) The first name of the customer or guest.

lastname - String!

(BETA) The last name of the customer or guest.

postcode - String

(BETA) The ZIP or postal code of the billing or shipping address.

region - String

(BETA) A string that defines the state or province of the billing or shipping address.

region_id - Int

(BETA) An integer that defines the state or province of the billing or shipping address.

save_in_address_book - Boolean

(BETA) Determines whether to save the address in the customer's address book. The default value is true.

street - [String]!

(BETA) An array containing the street for the billing or shipping address.

telephone - String

(BETA) The telephone number for the billing or shipping address.

vat_id - String

(BETA) The VAT company number for billing or shipping address.

Example
{
  "city": "xyz789",
  "company": "abc123",
  "country_code": "abc123",
  "firstname": "abc123",
  "lastname": "xyz789",
  "postcode": "xyz789",
  "region": "xyz789",
  "region_id": 987,
  "save_in_address_book": true,
  "street": ["xyz789"],
  "telephone": "xyz789",
  "vat_id": "abc123"
}

CartAddressInterface

Fields
Field Name Description
city - String! (BETA) The city specified for the billing or shipping address.
company - String (BETA) The company specified for the billing or shipping address.
country - CartAddressCountry! (BETA) An object containing the country label and code.
firstname - String! (BETA) The first name of the customer or guest.
lastname - String! (BETA) The last name of the customer or guest.
postcode - String (BETA) The ZIP or postal code of the billing or shipping address.
region - CartAddressRegion (BETA) An object containing the region label and code.
street - [String]! (BETA) An array containing the street for the billing or shipping address.
telephone - String (BETA) The telephone number for the billing or shipping address.
uid - String! (BETA) The unique id of the customer address.
vat_id - String (BETA) The VAT company number for billing or shipping address.
Possible Types
CartAddressInterface Types

ShippingCartAddress

BillingCartAddress

Example
{
  "city": "abc123",
  "company": "xyz789",
  "country": CartAddressCountry,
  "firstname": "abc123",
  "lastname": "abc123",
  "postcode": "xyz789",
  "region": CartAddressRegion,
  "street": ["abc123"],
  "telephone": "xyz789",
  "uid": "xyz789",
  "vat_id": "abc123"
}

CartAddressRegion

Description

(BETA) Contains details about the region in a billing or shipping address.

Fields
Field Name Description
code - String (BETA) The state or province code.
label - String (BETA) The display label for the region.
region_id - Int (BETA) The unique ID for a pre-defined region.
Example
{
  "code": "xyz789",
  "label": "abc123",
  "region_id": 123
}

CartDiscount

Description

(BETA) Contains information about discounts applied to the cart.

Fields
Field Name Description
amount - Money! (BETA) The amount of the discount applied to the item.
label - [String]! (BETA) The description of the discount.
Example
{
  "amount": Money,
  "label": ["abc123"]
}

CartItemError

Fields
Field Name Description
code - CartItemErrorType! (BETA) An error code that describes the error encountered
message - String! (BETA) A localized error message
Example
{"code": "UNDEFINED", "message": "xyz789"}

CartItemErrorType

Values
Enum Value Description

UNDEFINED

ITEM_QTY

ITEM_INCREMENTS

Example
"UNDEFINED"

CartItemInput

Description

(BETA) Defines an item to be added to the cart.

Fields
Input Field Description
entered_options - [EnteredOptionInput]

(BETA) An array of entered options for the base product, such as personalization text.

parent_sku - String

(BETA) For a child product, the SKU of its parent product.

quantity - Float!

(BETA) The amount or number of an item to add.

selected_options - [ID]

(BETA) The selected options for the base product, such as color or size, using the unique ID for an object such as CustomizableRadioOption, CustomizableDropDownOption, or ConfigurableProductOptionsValues.

sku - String!

(BETA) The SKU of the product.

Example
{
  "entered_options": [EnteredOptionInput],
  "parent_sku": "xyz789",
  "quantity": 987.65,
  "selected_options": ["4"],
  "sku": "abc123"
}

CartItemInterface

Description

(BETA) An interface for products in a cart.

Fields
Field Name Description
errors - [CartItemError] (BETA) An array of errors encountered while loading the cart item
id - String! Use uid instead.
prices - CartItemPrices (BETA) Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! (BETA) Details about an item in the cart.
quantity - Float! (BETA) The quantity of this item in the cart.
uid - ID! (BETA) The unique ID for a CartItemInterface object.
Example
{
  "errors": [CartItemError],
  "id": "abc123",
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 987.65,
  "uid": 4
}

CartItemPrices

Description

(BETA) Contains details about the price of the item, including taxes and discounts.

Fields
Field Name Description
discounts - [Discount] (BETA) An array of discounts to be applied to the cart item.
fixed_product_taxes - [FixedProductTax] (BETA) An array of FPTs applied to the cart item.
price - Money! (BETA) The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.
price_including_tax - Money! (BETA) The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.
row_total - Money! (BETA) The value of the price multiplied by the quantity of the item.
row_total_including_tax - Money! (BETA) The value of row_total plus the tax applied to the item.
total_item_discount - Money (BETA) The total of all discounts applied to the item.
Example
{
  "discounts": [Discount],
  "fixed_product_taxes": [FixedProductTax],
  "price": Money,
  "price_including_tax": Money,
  "row_total": Money,
  "row_total_including_tax": Money,
  "total_item_discount": Money
}

CartItemQuantity

Description

(BETA) Deprecated: The ShippingCartAddress.cart_items field now returns CartItemInterface.

Fields
Field Name Description
cart_item_id - Int! The ShippingCartAddress.cart_items field now returns CartItemInterface.
quantity - Float! The ShippingCartAddress.cart_items field now returns CartItemInterface.
Example
{"cart_item_id": 987, "quantity": 987.65}

CartItemSelectedOptionValuePrice

Description

(BETA) Contains details about the price of a selected customizable value.

Fields
Field Name Description
type - PriceTypeEnum! (BETA) Indicates whether the price type is fixed, percent, or dynamic.
units - String! (BETA) A string that describes the unit of the value.
value - Float! (BETA) A price value.
Example
{
  "type": "FIXED",
  "units": "abc123",
  "value": 987.65
}

CartItemUpdateInput

Description

(BETA) A single item to be updated.

Fields
Input Field Description
cart_item_id - Int

(BETA) Deprecated. Use cart_item_uid instead.

cart_item_uid - ID

(BETA) The unique ID for a CartItemInterface object.

customizable_options - [CustomizableOptionInput]

(BETA) An array that defines customizable options for the product.

gift_message - GiftMessageInput

(BETA) Gift message details for the cart item

gift_wrapping_id - ID

(BETA) The unique ID for a GiftWrapping object to be used for the cart item.

quantity - Float

(BETA) The new quantity of the item.

Example
{
  "cart_item_id": 987,
  "cart_item_uid": 4,
  "customizable_options": [CustomizableOptionInput],
  "gift_message": GiftMessageInput,
  "gift_wrapping_id": "4",
  "quantity": 987.65
}

CartPrices

Description

(BETA) Contains details about the final price of items in the cart, including discount and tax information.

Fields
Field Name Description
applied_taxes - [CartTaxItem] (BETA) An array containing the names and amounts of taxes applied to each item in the cart.
discount - CartDiscount Use discounts instead.
discounts - [Discount] (BETA) An array containing cart rule discounts, store credit and gift cards applied to the cart.
gift_options - GiftOptionsPrices (BETA) The list of prices for the selected gift options.
grand_total - Money (BETA) The total, including discounts, taxes, shipping, and other fees.
subtotal_excluding_tax - Money (BETA) The subtotal without any applied taxes.
subtotal_including_tax - Money (BETA) The subtotal including any applied taxes.
subtotal_with_discount_excluding_tax - Money (BETA) The subtotal with any discounts applied, but not taxes.
Example
{
  "applied_taxes": [CartTaxItem],
  "discount": CartDiscount,
  "discounts": [Discount],
  "gift_options": GiftOptionsPrices,
  "grand_total": Money,
  "subtotal_excluding_tax": Money,
  "subtotal_including_tax": Money,
  "subtotal_with_discount_excluding_tax": Money
}

CartTaxItem

Description

(BETA) Contains tax information about an item in the cart.

Fields
Field Name Description
amount - Money! (BETA) The amount of tax applied to the item.
label - String! (BETA) The description of the tax.
Example
{
  "amount": Money,
  "label": "abc123"
}

CartUserInputError

Description

(BETA) An error encountered while adding an item to the the cart.

Fields
Field Name Description
code - CartUserInputErrorType! (BETA) A cart-specific error code.
message - String! (BETA) A localized error message.
Example
{
  "code": "PRODUCT_NOT_FOUND",
  "message": "abc123"
}

CartUserInputErrorType

Values
Enum Value Description

PRODUCT_NOT_FOUND

NOT_SALABLE

INSUFFICIENT_STOCK

UNDEFINED

PERMISSION_DENIED

Example
"PRODUCT_NOT_FOUND"

CategoryFilterInput

Description

(BETA) Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.

Fields
Input Field Description
category_uid - FilterEqualTypeInput

(BETA) Filter by the unique category ID for a CategoryInterface object.

ids - FilterEqualTypeInput

(BETA) Deprecated: use 'category_uid' to filter uniquely identifiers of categories.

name - FilterMatchTypeInput

(BETA) Filter by the display name of the category.

parent_category_uid - FilterEqualTypeInput

(BETA) Filter by the unique parent category ID for a CategoryInterface object.

parent_id - FilterEqualTypeInput

(BETA) Filter by the unique parent category ID for a CategoryInterface object.

url_key - FilterEqualTypeInput

(BETA) Filter by the part of the URL that identifies the category.

url_path - FilterEqualTypeInput

(BETA) Filter by the URL path for the category.

Example
{
  "category_uid": FilterEqualTypeInput,
  "ids": FilterEqualTypeInput,
  "name": FilterMatchTypeInput,
  "parent_category_uid": FilterEqualTypeInput,
  "parent_id": FilterEqualTypeInput,
  "url_key": FilterEqualTypeInput,
  "url_path": FilterEqualTypeInput
}

CategoryInterface

Description

(BETA) Contains the full set of attributes that can be returned in a category search.

Fields
Field Name Description
automatic_sorting - String
available_sort_by - [String]
breadcrumbs - [Breadcrumb] (BETA) An array of breadcrumb items.
canonical_url - String (BETA) The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.
children_count - String
cms_block - CmsBlock (BETA) Contains a category CMS block.
created_at - String (BETA) The timestamp indicating when the category was created. The field should not be used on the storefront.
custom_layout_update_file - String
default_sort_by - String (BETA) The attribute to use for sorting.
description - String (BETA) An optional description of the category.
display_mode - String
filter_price_range - Float
id - Int (BETA) An ID that uniquely identifies the category. Use uid instead.
image - String
include_in_menu - Int
is_anchor - Int
landing_page - Int
level - Int (BETA) The depth of the category within the tree.
meta_description - String
meta_keywords - String
meta_title - String
name - String (BETA) The display name of the category.
path - String (BETA) The full category path.
path_in_store - String (BETA) The category path within the store.
position - Int (BETA) The position of the category relative to other categories at the same level in tree.
product_count - Int (BETA) The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.
products - CategoryProducts (BETA) The list of products assigned to the category.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default value is 20.

currentPage - Int

(BETA) The page of results to return. The default value is 1.

sort - ProductAttributeSortInput

(BETA) The attributes to sort on, and whether to return the results in ascending or descending order.

staged - Boolean! (BETA) Indicates whether the category is staged for a future campaign.
uid - ID! (BETA) The unique ID for a CategoryInterface object.
updated_at - String (BETA) The timestamp indicating when the category was updated. The field should not be used on the storefront.
url_key - String (BETA) The URL key assigned to the category.
url_path - String (BETA) The URL path assigned to the category.
url_suffix - String (BETA) The part of the category URL that is appended after the url key
Possible Types
CategoryInterface Types

CategoryTree

Example
{
  "automatic_sorting": "abc123",
  "available_sort_by": ["abc123"],
  "breadcrumbs": [Breadcrumb],
  "canonical_url": "abc123",
  "children_count": "xyz789",
  "cms_block": CmsBlock,
  "created_at": "abc123",
  "custom_layout_update_file": "xyz789",
  "default_sort_by": "xyz789",
  "description": "xyz789",
  "display_mode": "abc123",
  "filter_price_range": 987.65,
  "id": 987,
  "image": "xyz789",
  "include_in_menu": 987,
  "is_anchor": 987,
  "landing_page": 123,
  "level": 987,
  "meta_description": "abc123",
  "meta_keywords": "abc123",
  "meta_title": "xyz789",
  "name": "abc123",
  "path": "xyz789",
  "path_in_store": "xyz789",
  "position": 123,
  "product_count": 123,
  "products": CategoryProducts,
  "staged": false,
  "uid": "4",
  "updated_at": "abc123",
  "url_key": "xyz789",
  "url_path": "xyz789",
  "url_suffix": "abc123"
}

CategoryProducts

Description

(BETA) Contains details about the products assigned to a category.

Fields
Field Name Description
items - [ProductInterface] (BETA) An array of products that are assigned to the category.
page_info - SearchResultPageInfo (BETA) Pagination metadata.
total_count - Int (BETA) The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.
Example
{
  "items": [ProductInterface],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

CategoryResult

Description

(BETA) Contains a collection of CategoryTree objects and pagination information.

Fields
Field Name Description
items - [CategoryTree] (BETA) A list of categories that match the filter criteria.
page_info - SearchResultPageInfo (BETA) An object that includes the page_info and currentPage values specified in the query.
total_count - Int (BETA) The total number of categories that match the criteria.
Example
{
  "items": [CategoryTree],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

CategoryTree

Description

(BETA) Contains the hierarchy of categories.

Fields
Field Name Description
automatic_sorting - String
available_sort_by - [String]
breadcrumbs - [Breadcrumb] (BETA) An array of breadcrumb items.
canonical_url - String (BETA) The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.
children - [CategoryTree] (BETA) A tree of child categories.
children_count - String
cms_block - CmsBlock (BETA) Contains a category CMS block.
created_at - String (BETA) The timestamp indicating when the category was created. The field should not be used on the storefront.
custom_layout_update_file - String
default_sort_by - String (BETA) The attribute to use for sorting.
description - String (BETA) An optional description of the category.
display_mode - String
filter_price_range - Float
id - Int (BETA) An ID that uniquely identifies the category. Use uid instead.
image - String
include_in_menu - Int
is_anchor - Int
landing_page - Int
level - Int (BETA) The depth of the category within the tree.
meta_description - String
meta_keywords - String
meta_title - String
name - String (BETA) The display name of the category.
path - String (BETA) The full category path.
path_in_store - String (BETA) The category path within the store.
position - Int (BETA) The position of the category relative to other categories at the same level in tree.
product_count - Int (BETA) The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.
products - CategoryProducts (BETA) The list of products assigned to the category.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default value is 20.

currentPage - Int

(BETA) The page of results to return. The default value is 1.

sort - ProductAttributeSortInput

(BETA) The attributes to sort on, and whether to return the results in ascending or descending order.

redirect_code - Int! (BETA) Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String (BETA) The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
staged - Boolean! (BETA) Indicates whether the category is staged for a future campaign.
type - UrlRewriteEntityTypeEnum (BETA) One of PRODUCT, CATEGORY, or CMS_PAGE.
uid - ID! (BETA) The unique ID for a CategoryInterface object.
updated_at - String (BETA) The timestamp indicating when the category was updated. The field should not be used on the storefront.
url_key - String (BETA) The URL key assigned to the category.
url_path - String (BETA) The URL path assigned to the category.
url_suffix - String (BETA) The part of the category URL that is appended after the url key
Example
{
  "automatic_sorting": "xyz789",
  "available_sort_by": ["abc123"],
  "breadcrumbs": [Breadcrumb],
  "canonical_url": "xyz789",
  "children": [CategoryTree],
  "children_count": "xyz789",
  "cms_block": CmsBlock,
  "created_at": "xyz789",
  "custom_layout_update_file": "xyz789",
  "default_sort_by": "abc123",
  "description": "abc123",
  "display_mode": "abc123",
  "filter_price_range": 987.65,
  "id": 123,
  "image": "xyz789",
  "include_in_menu": 123,
  "is_anchor": 987,
  "landing_page": 987,
  "level": 123,
  "meta_description": "abc123",
  "meta_keywords": "xyz789",
  "meta_title": "abc123",
  "name": "abc123",
  "path": "abc123",
  "path_in_store": "xyz789",
  "position": 123,
  "product_count": 987,
  "products": CategoryProducts,
  "redirect_code": 123,
  "relative_url": "xyz789",
  "staged": false,
  "type": "CMS_PAGE",
  "uid": 4,
  "updated_at": "abc123",
  "url_key": "xyz789",
  "url_path": "xyz789",
  "url_suffix": "xyz789"
}

CheckoutAgreement

Description

(BETA) Defines details about an individual checkout agreement.

Fields
Field Name Description
agreement_id - Int! (BETA) The ID for a checkout agreement.
checkbox_text - String! (BETA) The checkbox text for the checkout agreement.
content - String! (BETA) Required. The text of the agreement.
content_height - String (BETA) The height of the text box where the Terms and Conditions statement appears during checkout.
is_html - Boolean! (BETA) Indicates whether the content text is in HTML format.
mode - CheckoutAgreementMode! (BETA) Indicates whether agreements are accepted automatically or manually.
name - String! (BETA) The name given to the condition.
Example
{
  "agreement_id": 123,
  "checkbox_text": "abc123",
  "content": "abc123",
  "content_height": "xyz789",
  "is_html": false,
  "mode": "AUTO",
  "name": "xyz789"
}

CheckoutAgreementMode

Description

(BETA) Indicates how agreements are accepted.

Values
Enum Value Description

AUTO

(BETA) Conditions are automatically accepted upon checkout.

MANUAL

(BETA) Shoppers must manually accept the conditions to place an order.
Example
"AUTO"

CheckoutUserInputError

Description

(BETA) An error encountered while adding an item to the cart.

Fields
Field Name Description
code - CheckoutUserInputErrorCodes! (BETA) An error code that is specific to Checkout.
message - String! (BETA) A localized error message.
path - [String]! (BETA) The path to the input field that caused an error. See the GraphQL specification about path errors for details: http://spec.graphql.org/draft/#sec-Errors
Example
{
  "code": "REORDER_NOT_AVAILABLE",
  "message": "xyz789",
  "path": ["abc123"]
}

CheckoutUserInputErrorCodes

Values
Enum Value Description

REORDER_NOT_AVAILABLE

PRODUCT_NOT_FOUND

NOT_SALABLE

INSUFFICIENT_STOCK

UNDEFINED

Example
"REORDER_NOT_AVAILABLE"

ClearCustomerCartOutput

Description

(BETA) Output of the request to clear the customer cart.

Fields
Field Name Description
cart - Cart (BETA) The cart after clearing items.
status - Boolean! (BETA) Indicates whether cart was cleared.
Example
{"cart": Cart, "status": true}

CloseNegotiableQuoteError

Example
NegotiableQuoteInvalidStateError

CloseNegotiableQuoteOperationFailure

Description

(BETA) Contains details about a failed close operation on a negotiable quote.

Fields
Field Name Description
errors - [CloseNegotiableQuoteError]! (BETA) An array of errors encountered while attempting close the negotiable quote.
quote_uid - ID! (BETA) The unique ID of a NegotiableQuote object.
Example
{
  "errors": [NegotiableQuoteInvalidStateError],
  "quote_uid": "4"
}

CloseNegotiableQuoteOperationResult

Example
NegotiableQuoteUidOperationSuccess

CloseNegotiableQuotesInput

Description

(BETA) Defines the negotiable quotes to mark as closed.

Fields
Input Field Description
quote_uids - [ID]!

(BETA) A list of unique IDs from NegotiableQuote objects.

Example
{"quote_uids": [4]}

CloseNegotiableQuotesOutput

Description

(BETA) Contains the closed negotiable quotes and other negotiable quotes the company user can view.

Fields
Field Name Description
closed_quotes - [NegotiableQuote] (BETA) An array containing the negotiable quotes that were just closed. Use operation_results instead.
negotiable_quotes - NegotiableQuotesOutput (BETA) A list of negotiable quotes that can be viewed by the logged-in customer
Arguments
filter - NegotiableQuoteFilterInput

(BETA) The filter to use to determine which negotiable quotes to close.

pageSize - Int

(BETA) The maximum number of results to return at once. The default value is 20.

currentPage - Int

(BETA) The page of results to return. The default value is 1.

sort - NegotiableQuoteSortInput

(BETA) The field to use for sorting results.

operation_results - [CloseNegotiableQuoteOperationResult]! (BETA) An array of closed negotiable quote UIDs and details about any errors.
result_status - BatchMutationStatus! (BETA) The status of the request to close one or more negotiable quotes.
Example
{
  "closed_quotes": [NegotiableQuote],
  "negotiable_quotes": NegotiableQuotesOutput,
  "operation_results": [
    NegotiableQuoteUidOperationSuccess
  ],
  "result_status": "SUCCESS"
}

CmsBlock

Description

(BETA) Contains details about a specific CMS block.

Fields
Field Name Description
content - String (BETA) The content of the CMS block in raw HTML.
identifier - String (BETA) The CMS block identifier.
title - String (BETA) The title assigned to the CMS block.
Example
{
  "content": "xyz789",
  "identifier": "abc123",
  "title": "abc123"
}

CmsBlocks

Description

(BETA) Contains an array CMS block items.

Fields
Field Name Description
items - [CmsBlock] (BETA) An array of CMS blocks.
Example
{"items": [CmsBlock]}

CmsPage

Description

(BETA) Contains details about a CMS page.

Fields
Field Name Description
content - String (BETA) The content of the CMS page in raw HTML.
content_heading - String (BETA) The heading that displays at the top of the CMS page.
identifier - String (BETA) The ID of a CMS page.
meta_description - String (BETA) A brief description of the page for search results listings.
meta_keywords - String (BETA) A brief description of the page for search results listings.
meta_title - String (BETA) A page title that is indexed by search engines and appears in search results listings.
page_layout - String (BETA) The design layout of the page, indicating the number of columns and navigation features used on the page.
redirect_code - Int! (BETA) Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String (BETA) The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
title - String (BETA) The name that appears in the breadcrumb trail navigation and in the browser title bar and tab.
type - UrlRewriteEntityTypeEnum (BETA) One of PRODUCT, CATEGORY, or CMS_PAGE.
url_key - String (BETA) The URL key of the CMS page, which is often based on the content_heading.
Example
{
  "content": "xyz789",
  "content_heading": "xyz789",
  "identifier": "xyz789",
  "meta_description": "xyz789",
  "meta_keywords": "abc123",
  "meta_title": "xyz789",
  "page_layout": "xyz789",
  "redirect_code": 123,
  "relative_url": "abc123",
  "title": "abc123",
  "type": "CMS_PAGE",
  "url_key": "xyz789"
}

ColorSwatchData

Fields
Field Name Description
value - String (BETA) The value can be represented as color (HEX code), image link, or text.
Example
{"value": "abc123"}

Company

Description

(BETA) Contains the output schema for a company.

Fields
Field Name Description
acl_resources - [CompanyAclResource] (BETA) The list of all resources defined within the company.
company_admin - Customer (BETA) An object containing information about the company administrator.
credit - CompanyCredit! (BETA) Company credit balances and limits.
credit_history - CompanyCreditHistory! (BETA) Details about the history of company credit operations.
Arguments
pageSize - Int
currentPage - Int
email - String (BETA) The email address of the company contact.
id - ID! (BETA) The unique ID of a Company object.
legal_address - CompanyLegalAddress (BETA) The address where the company is registered to conduct business.
legal_name - String (BETA) The full legal name of the company.
name - String (BETA) The name of the company.
payment_methods - [String] (BETA) The list of payment methods available to a company.
reseller_id - String (BETA) The resale number that is assigned to the company for tax reporting purposes.
role - CompanyRole (BETA) A company role filtered by the unique ID of a CompanyRole object.
Arguments
id - ID!
roles - CompanyRoles! (BETA) An object that contains a list of company roles.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default value is 20.

currentPage - Int

(BETA) The page of results to return. The default value is 1

sales_representative - CompanySalesRepresentative (BETA) An object containing information about the company sales representative.
structure - CompanyStructure (BETA) The company structure of teams and customers in depth-first order.
Arguments
rootId - ID

(BETA) The ID of the node in the company structure that serves as the root for the query.

depth - Int

(BETA) The maximum number of levels of the structure to return.

team - CompanyTeam (BETA) The company team data filtered by the unique ID for a CompanyTeam object.
Arguments
id - ID!
user - Customer (BETA) A company user filtered by the unique ID of a Customer object.
Arguments
id - ID!
users - CompanyUsers (BETA) An object that contains a list of company users based on activity status.
Arguments
filter - CompanyUsersFilterInput

(BETA) The type of company users to return.

pageSize - Int

(BETA) The maximum number of results to return at once. The default value is 20.

currentPage - Int

(BETA) The page of results to return. The default value is 1.

vat_tax_id - String (BETA) The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.
Example
{
  "acl_resources": [CompanyAclResource],
  "company_admin": Customer,
  "credit": CompanyCredit,
  "credit_history": CompanyCreditHistory,
  "email": "abc123",
  "id": "4",
  "legal_address": CompanyLegalAddress,
  "legal_name": "xyz789",
  "name": "xyz789",
  "payment_methods": ["xyz789"],
  "reseller_id": "abc123",
  "role": CompanyRole,
  "roles": CompanyRoles,
  "sales_representative": CompanySalesRepresentative,
  "structure": CompanyStructure,
  "team": CompanyTeam,
  "user": Customer,
  "users": CompanyUsers,
  "vat_tax_id": "xyz789"
}

CompanyAclResource

Description

(BETA) Contains details about the access control list settings of a resource.

Fields
Field Name Description
children - [CompanyAclResource] (BETA) An array of sub-resources.
id - ID! (BETA) The unique ID for a CompanyAclResource object.
sort_order - Int (BETA) The sort order of an ACL resource.
text - String (BETA) The label assigned to the ACL resource.
Example
{
  "children": [CompanyAclResource],
  "id": "4",
  "sort_order": 987,
  "text": "xyz789"
}

CompanyAdminInput

Description

(BETA) Defines the input schema for creating a company administrator.

Fields
Input Field Description
email - String!

(BETA) The email address of the company administrator.

firstname - String!

(BETA) The company administrator's first name.

gender - Int

(BETA) The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).

job_title - String

(BETA) The job title of the company administrator.

lastname - String!

(BETA) The company administrator's last name.

Example
{
  "email": "abc123",
  "firstname": "xyz789",
  "gender": 123,
  "job_title": "xyz789",
  "lastname": "xyz789"
}

CompanyCreateInput

Description

(BETA) Defines the input schema for creating a new company.

Fields
Input Field Description
company_admin - CompanyAdminInput!

(BETA) Defines the company administrator.

company_email - String!

(BETA) The email address of the company contact.

company_name - String!

(BETA) The name of the company to create.

legal_address - CompanyLegalAddressCreateInput!

(BETA) Defines legal address data of the company.

legal_name - String

(BETA) The full legal name of the company.

reseller_id - String

(BETA) The resale number that is assigned to the company for tax reporting purposes.

vat_tax_id - String

(BETA) The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.

Example
{
  "company_admin": CompanyAdminInput,
  "company_email": "xyz789",
  "company_name": "xyz789",
  "legal_address": CompanyLegalAddressCreateInput,
  "legal_name": "abc123",
  "reseller_id": "xyz789",
  "vat_tax_id": "xyz789"
}

CompanyCredit

Description

(BETA) Contains company credit balances and limits.

Fields
Field Name Description
available_credit - Money! (BETA) The sum of the credit limit and the outstanding balance. If the company has exceeded the credit limit, the amount is as a negative value.
credit_limit - Money! (BETA) The amount of credit extended to the company.
outstanding_balance - Money! (BETA) The amount reimbursed, less the total due from all orders placed using the Payment on Account payment method. The amount can be a positive or negative value.
Example
{
  "available_credit": Money,
  "credit_limit": Money,
  "outstanding_balance": Money
}

CompanyCreditHistory

Description

(BETA) Contains details about prior company credit operations.

Fields
Field Name Description
items - [CompanyCreditOperation]! (BETA) An array of company credit operations.
page_info - SearchResultPageInfo! (BETA) Metadata for pagination rendering.
total_count - Int (BETA) The number of the company credit operations matching the specified filter.
Example
{
  "items": [CompanyCreditOperation],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CompanyCreditHistoryFilterInput

Description

(BETA) Defines a filter for narrowing the results of a credit history search.

Fields
Input Field Description
custom_reference_number - String

(BETA) The purchase order number associated with the company credit operation.

operation_type - CompanyCreditOperationType

(BETA) The type of the company credit operation.

updated_by - String

(BETA) The name of the person submitting the company credit operation.

Example
{
  "custom_reference_number": "abc123",
  "operation_type": "ALLOCATION",
  "updated_by": "abc123"
}

CompanyCreditOperation

Description

(BETA) Contains details about a single company credit operation.

Fields
Field Name Description
amount - Money (BETA) The amount of the company credit operation.
balance - CompanyCredit! (BETA) The credit balance as a result of the operation.
custom_reference_number - String (BETA) The purchase order number associated with the company credit operation.
date - String! (BETA) The date the operation occurred.
type - CompanyCreditOperationType! (BETA) The type of the company credit operation.
updated_by - CompanyCreditOperationUser! (BETA) The company user that submitted the company credit operation.
Example
{
  "amount": Money,
  "balance": CompanyCredit,
  "custom_reference_number": "abc123",
  "date": "abc123",
  "type": "ALLOCATION",
  "updated_by": CompanyCreditOperationUser
}

CompanyCreditOperationType

Values
Enum Value Description

ALLOCATION

UPDATE

PURCHASE

REIMBURSEMENT

REFUND

REVERT

Example
"ALLOCATION"

CompanyCreditOperationUser

Description

(BETA) Defines the administrator or company user that submitted a company credit operation.

Fields
Field Name Description
name - String! (BETA) The name of the company user submitting the company credit operation.
type - CompanyCreditOperationUserType! (BETA) The type of the company user submitting the company credit operation.
Example
{"name": "xyz789", "type": "CUSTOMER"}

CompanyCreditOperationUserType

Values
Enum Value Description

CUSTOMER

ADMIN

Example
"CUSTOMER"

CompanyLegalAddress

Description

(BETA) Contains details about the address where the company is registered to conduct business.

Fields
Field Name Description
city - String (BETA) The city where the company is registered to conduct business.
country_code - CountryCodeEnum (BETA) The country code of the company's legal address.
postcode - String (BETA) The company's postal code.
region - CustomerAddressRegion (BETA) An object containing region data for the company.
street - [String] (BETA) An array of strings that define the company's street address.
telephone - String (BETA) The company's phone number.
Example
{
  "city": "xyz789",
  "country_code": "AF",
  "postcode": "abc123",
  "region": CustomerAddressRegion,
  "street": ["xyz789"],
  "telephone": "abc123"
}

CompanyLegalAddressCreateInput

Description

(BETA) Defines the input schema for defining a company's legal address.

Fields
Input Field Description
city - String!

(BETA) The city where the company is registered to conduct business.

country_id - CountryCodeEnum!

(BETA) The company's country ID. Use the countries query to get this value.

postcode - String!

(BETA) The postal code of the company.

region - CustomerAddressRegionInput!

(BETA) An object containing the region name and/or region ID where the company is registered to conduct business.

street - [String]!

(BETA) An array of strings that define the street address where the company is registered to conduct business.

telephone - String!

(BETA) The primary phone number of the company.

Example
{
  "city": "abc123",
  "country_id": "AF",
  "postcode": "xyz789",
  "region": CustomerAddressRegionInput,
  "street": ["abc123"],
  "telephone": "abc123"
}

CompanyLegalAddressUpdateInput

Description

(BETA) Defines the input schema for updating a company's legal address.

Fields
Input Field Description
city - String

(BETA) The city where the company is registered to conduct business.

country_id - CountryCodeEnum

(BETA) The unique ID for a Country object.

postcode - String

(BETA) The postal code of the company.

region - CustomerAddressRegionInput

(BETA) An object containing the region name and/or region ID where the company is registered to conduct business.

street - [String]

(BETA) An array of strings that define the street address where the company is registered to conduct business.

telephone - String

(BETA) The primary phone number of the company.

Example
{
  "city": "abc123",
  "country_id": "AF",
  "postcode": "abc123",
  "region": CustomerAddressRegionInput,
  "street": ["xyz789"],
  "telephone": "xyz789"
}

CompanyRole

Description

(BETA) Contails details about a single role.

Fields
Field Name Description
id - ID! (BETA) The unique ID for a CompanyRole object.
name - String (BETA) The name assigned to the role.
permissions - [CompanyAclResource] (BETA) A list of permission resources defined for a role.
users_count - Int (BETA) The total number of users assigned the specified role.
Example
{
  "id": 4,
  "name": "xyz789",
  "permissions": [CompanyAclResource],
  "users_count": 987
}

CompanyRoleCreateInput

Description

(BETA) Defines the input schema for creating a company role.

Fields
Input Field Description
name - String!

(BETA) The name of the role to create.

permissions - [String]!

(BETA) A list of resources the role can access.

Example
{
  "name": "abc123",
  "permissions": ["xyz789"]
}

CompanyRoleUpdateInput

Description

(BETA) Defines the input schema for updating a company role.

Fields
Input Field Description
id - ID!

(BETA) The unique ID for a CompanyRole object.

name - String

(BETA) The name of the role to update.

permissions - [String]

(BETA) A list of resources the role can access.

Example
{
  "id": "4",
  "name": "abc123",
  "permissions": ["xyz789"]
}

CompanyRoles

Description

(BETA) Contains an array of roles.

Fields
Field Name Description
items - [CompanyRole]! (BETA) A list of company roles that match the specified filter criteria.
page_info - SearchResultPageInfo (BETA) Pagination metadata.
total_count - Int! (BETA) The total number of objects matching the specified filter.
Example
{
  "items": [CompanyRole],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CompanySalesRepresentative

Description

(BETA) Contains details about a company sales representative.

Fields
Field Name Description
email - String (BETA) The email address of the company sales representative.
firstname - String (BETA) The company sales representative's first name.
lastname - String (BETA) The company sales representative's last name.
Example
{
  "email": "xyz789",
  "firstname": "xyz789",
  "lastname": "xyz789"
}

CompanyStructure

Description

(BETA) Contains an array of the individual nodes that comprise the company structure.

Fields
Field Name Description
items - [CompanyStructureItem] (BETA) An array of elements in a company structure.
Example
{"items": [CompanyStructureItem]}

CompanyStructureEntity

Types
Union Types

CompanyTeam

Customer

Example
CompanyTeam

CompanyStructureItem

Description

(BETA) Defines an individual node in the company structure.

Fields
Field Name Description
entity - CompanyStructureEntity (BETA) A union of CompanyTeam and Customer objects.
id - ID! (BETA) The unique ID for a CompanyStructureItem object.
parent_id - ID (BETA) The ID of the parent item in the company hierarchy.
Example
{"entity": CompanyTeam, "id": 4, "parent_id": 4}

CompanyStructureUpdateInput

Description

(BETA) Defines the input schema for updating the company structure.

Fields
Input Field Description
parent_tree_id - ID!

(BETA) The ID of a company that will be the new parent.

tree_id - ID!

(BETA) The ID of the company team that is being moved to another parent.

Example
{"parent_tree_id": "4", "tree_id": 4}

CompanyTeam

Description

(BETA) Describes a company team.

Fields
Field Name Description
description - String (BETA) An optional description of the team.
id - ID! (BETA) The unique ID for a CompanyTeam object.
name - String (BETA) The display name of the team.
structure_id - ID! (BETA) ID of the company structure
Example
{
  "description": "abc123",
  "id": "4",
  "name": "abc123",
  "structure_id": "4"
}

CompanyTeamCreateInput

Description

(BETA) Defines the input schema for creating a company team.

Fields
Input Field Description
description - String

(BETA) An optional description of the team.

name - String!

(BETA) The display name of the team.

target_id - ID

(BETA) The ID of a node within a company's structure. This ID will be the parent of the created team.

Example
{
  "description": "xyz789",
  "name": "xyz789",
  "target_id": "4"
}

CompanyTeamUpdateInput

Description

(BETA) Defines the input schema for updating a company team.

Fields
Input Field Description
description - String

(BETA) An optional description of the team.

id - ID!

(BETA) The unique ID of the CompanyTeam object to update.

name - String

(BETA) The display name of the team.

Example
{
  "description": "xyz789",
  "id": 4,
  "name": "xyz789"
}

CompanyUpdateInput

Description

(BETA) Defines the input schema for updating a company.

Fields
Input Field Description
company_email - String

(BETA) The email address of the company contact.

company_name - String

(BETA) The name of the company to update.

legal_address - CompanyLegalAddressUpdateInput

(BETA) The legal address data of the company.

legal_name - String

(BETA) The full legal name of the company.

reseller_id - String

(BETA) The resale number that is assigned to the company for tax reporting purposes.

vat_tax_id - String

(BETA) The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.

Example
{
  "company_email": "xyz789",
  "company_name": "abc123",
  "legal_address": CompanyLegalAddressUpdateInput,
  "legal_name": "xyz789",
  "reseller_id": "xyz789",
  "vat_tax_id": "xyz789"
}

CompanyUserCreateInput

Description

(BETA) Defines the input schema for creating a company user.

Fields
Input Field Description
email - String!

(BETA) The company user's email address

firstname - String!

(BETA) The company user's first name.

job_title - String!

(BETA) The company user's job title or function.

lastname - String!

(BETA) The company user's last name.

role_id - ID!

(BETA) The unique ID for a CompanyRole object.

status - CompanyUserStatusEnum!

(BETA) Indicates whether the company user is ACTIVE or INACTIVE.

target_id - ID

(BETA) The ID of a node within a company's structure. This ID will be the parent of the created company user.

telephone - String!

(BETA) The company user's phone number.

Example
{
  "email": "xyz789",
  "firstname": "xyz789",
  "job_title": "xyz789",
  "lastname": "abc123",
  "role_id": "4",
  "status": "ACTIVE",
  "target_id": "4",
  "telephone": "xyz789"
}

CompanyUserStatusEnum

Description

(BETA) Defines the list of company user status values.

Values
Enum Value Description

ACTIVE

(BETA) Only active users.

INACTIVE

(BETA) Only inactive users.
Example
"ACTIVE"

CompanyUserUpdateInput

Description

(BETA) Defines the input schema for updating a company user.

Fields
Input Field Description
email - String

(BETA) The company user's email address.

firstname - String

(BETA) The company user's first name.

id - ID!

(BETA) The unique ID of a Customer object.

job_title - String

(BETA) The company user's job title or function.

lastname - String

(BETA) The company user's last name.

role_id - ID

(BETA) The unique ID for a CompanyRole object.

status - CompanyUserStatusEnum

(BETA) Indicates whether the company user is ACTIVE or INACTIVE.

telephone - String

(BETA) The company user's phone number.

Example
{
  "email": "xyz789",
  "firstname": "abc123",
  "id": "4",
  "job_title": "abc123",
  "lastname": "xyz789",
  "role_id": "4",
  "status": "ACTIVE",
  "telephone": "xyz789"
}

CompanyUsers

Description

(BETA) Contains details about company users.

Fields
Field Name Description
items - [Customer]! (BETA) An array of CompanyUser objects that match the specified filter criteria.
page_info - SearchResultPageInfo (BETA) Pagination metadata.
total_count - Int! (BETA) The number of objects returned.
Example
{
  "items": [Customer],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CompanyUsersFilterInput

Description

(BETA) Defines the filter for returning a list of company users.

Fields
Input Field Description
status - CompanyUserStatusEnum

(BETA) The activity status to filter on.

Example
{"status": "ACTIVE"}

ComparableAttribute

Description

(BETA) Contains an attribute code that is used for product comparisons.

Fields
Field Name Description
code - String! (BETA) An attribute code that is enabled for product comparisons.
label - String! (BETA) The label of the attribute code.
Example
{
  "code": "abc123",
  "label": "abc123"
}

ComparableItem

Description

(BETA) Defines an object used to iterate through items for product comparisons.

Fields
Field Name Description
attributes - [ProductAttribute]! (BETA) An array of product attributes that can be used to compare products.
product - ProductInterface! (BETA) Details about a product in a compare list.
uid - ID! (BETA) The unique ID of an item in a compare list.
Example
{
  "attributes": [ProductAttribute],
  "product": ProductInterface,
  "uid": "4"
}

CompareList

Description

(BETA) Contains iterable information such as the array of items, the count, and attributes that represent the compare list.

Fields
Field Name Description
attributes - [ComparableAttribute] (BETA) An array of attributes that can be used for comparing products.
item_count - Int! (BETA) The number of items in the compare list.
items - [ComparableItem] (BETA) An array of products to compare.
uid - ID! (BETA) The unique ID assigned to the compare list.
Example
{
  "attributes": [ComparableAttribute],
  "item_count": 987,
  "items": [ComparableItem],
  "uid": "4"
}

ComplexTextValue

Fields
Field Name Description
html - String! (BETA) Text that can contain HTML tags.
Example
{"html": "xyz789"}

ConfigurableAttributeOption

Description

(BETA) Contains details about a configurable product attribute option.

Fields
Field Name Description
code - String (BETA) The ID assigned to the attribute.
label - String (BETA) A string that describes the configurable attribute option.
uid - ID! (BETA) The unique ID for a ConfigurableAttributeOption object.
value_index - Int (BETA) A unique index number assigned to the configurable product option.
Example
{
  "code": "xyz789",
  "label": "abc123",
  "uid": 4,
  "value_index": 987
}

ConfigurableCartItem

Description

(BETA) An implementation for configurable product cart items.

Fields
Field Name Description
available_gift_wrapping - [GiftWrapping]! (BETA) The list of available gift wrapping options for the cart item.
configurable_options - [SelectedConfigurableOption]! (BETA) An array containing the configuranle options the shopper selected.
configured_variant - ProductInterface! (BETA) Product details of the cart item.
customizable_options - [SelectedCustomizableOption]! (BETA) An array containing the customizable options the shopper selected.
errors - [CartItemError] (BETA) An array of errors encountered while loading the cart item
gift_message - GiftMessage (BETA) The entered gift message for the cart item
gift_wrapping - GiftWrapping (BETA) The selected gift wrapping for the cart item.
id - String! Use uid instead.
prices - CartItemPrices (BETA) Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! (BETA) Details about an item in the cart.
quantity - Float! (BETA) The quantity of this item in the cart.
uid - ID! (BETA) The unique ID for a CartItemInterface object.
Example
{
  "available_gift_wrapping": [GiftWrapping],
  "configurable_options": [SelectedConfigurableOption],
  "configured_variant": ProductInterface,
  "customizable_options": [SelectedCustomizableOption],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "xyz789",
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 987.65,
  "uid": "4"
}

ConfigurableOptionAvailableForSelection

Description

(BETA) Describes configurable options that have been selected and can be selected as a result of the previous selections.

Fields
Field Name Description
attribute_code - String! (BETA) An attribute code that uniquely identifies a configurable option.
option_value_uids - [ID]! (BETA) An array of selectable option value IDs.
Example
{
  "attribute_code": "abc123",
  "option_value_uids": ["4"]
}

ConfigurableProduct

Description

(BETA) Defines basic features of a configurable product and its simple product variants.

Fields
Field Name Description
activity - String Use the custom_attributes field instead.
attribute_set_id - Int (BETA) The attribute set assigned to the product. The field should not be used on the storefront.
canonical_url - String (BETA) The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] (BETA) The categories assigned to a product.
category_gear - String Use the custom_attributes field instead.
climate - String Use the custom_attributes field instead.
collar - String Use the custom_attributes field instead.
color - Int Use the custom_attributes field instead.
configurable_options - [ConfigurableProductOptions] (BETA) An array of options for the configurable product.
configurable_product_options_selection - ConfigurableProductOptionsSelection (BETA) An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options.
Arguments
configurableOptionValueUids - [ID!]
country_of_manufacture - String (BETA) The product's country of origin.
created_at - String (BETA) Timestamp indicating when the product was created. The field should not be used on the storefront.
crosssell_products - [ProductInterface] (BETA) An array of cross-sell products.
description - ComplexTextValue (BETA) Detailed information about the product. The value can include simple HTML tags.
eco_collection - Int Use the custom_attributes field instead.
erin_recommends - Int Use the custom_attributes field instead.
features_bags - String Use the custom_attributes field instead.
format - Int Use the custom_attributes field instead.
gender - String Use the custom_attributes field instead.
gift_message_available - String (BETA) Indicates whether a gift message is available.
id - Int (BETA) The ID number assigned to the product. Use the uid field instead.
image - ProductImage (BETA) The relative path to the main image on the product page.
is_returnable - String (BETA) Indicates whether the product can be returned.
manufacturer - Int (BETA) A number representing the product's manufacturer. Use the custom_attributes field instead.
material - String Use the custom_attributes field instead.
media_gallery - [MediaGalleryInterface] (BETA) An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] (BETA) An array of MediaGalleryEntry objects. Use media_gallery instead.
meta_description - String (BETA) A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String (BETA) A comma-separated list of keywords that are visible only to search engines.
meta_title - String (BETA) A string that is displayed in the title bar and tab of the browser and in search results lists.
name - String (BETA) The product name. Customers use this name to identify the product.
new - Int Use the custom_attributes field instead.
new_from_date - String (BETA) The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String (BETA) The end date for new product listings.
only_x_left_in_stock - Float (BETA) Product stock only x left count
options - [CustomizableOptionInterface] (BETA) An array of options for a customizable product.
options_container - String (BETA) If the product has multiple options, determines where they appear on the product page.
pattern - String Use the custom_attributes field instead.
performance_fabric - Int Use the custom_attributes field instead.
price - ProductPrices (BETA) Indicates the price of an item. Use price_range for product price information.
price_range - PriceRange! (BETA) The range of prices for the product
price_tiers - [TierPrice] (BETA) An array of TierPrice objects.
product_links - [ProductLinksInterface] (BETA) An array of ProductLinks objects.
purpose - Int Use the custom_attributes field instead.
rating_summary - Float! (BETA) The average of all the ratings given to the product.
redirect_code - Int! (BETA) Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] (BETA) An array of related products.
relative_url - String (BETA) The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! (BETA) The total count of all the reviews given to the product.
reviews - ProductReviews! (BETA) The list of products reviews.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default is 20.

currentPage - Int

(BETA) The page of results to return. The default is 1.

sale - Int Use the custom_attributes field instead.
short_description - ComplexTextValue (BETA) A short description of the product. Its use depends on the theme.
size - Int Use the custom_attributes field instead.
sku - String (BETA) A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String Use the custom_attributes field instead.
small_image - ProductImage (BETA) The relative path to the small image, which is used on catalog pages.
special_from_date - String (BETA) The beginning date that a product has a special price. The field should not be used on the storefront.
special_price - Float (BETA) The discounted price of the product.
special_to_date - String (BETA) The end date for a product with a special price.
staged - Boolean! (BETA) Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus (BETA) Stock status of the product
strap_bags - String Use the custom_attributes field instead.
style_bags - String Use the custom_attributes field instead.
style_bottom - String Use the custom_attributes field instead.
style_general - String Use the custom_attributes field instead.
swatch_image - String (BETA) The file name of a swatch image.
thumbnail - ProductImage (BETA) The relative path to the product's thumbnail image.
tier_price - Float (BETA) The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information.
tier_prices - [ProductTierPrices] (BETA) An array of ProductTierPrices objects. Use price_tiers for product tier price information.
type - UrlRewriteEntityTypeEnum (BETA) One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String (BETA) One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead.
uid - ID! (BETA) The unique ID for a ProductInterface object.
updated_at - String (BETA) Timestamp indicating when the product was updated. The field should not be used on the storefront.
upsell_products - [ProductInterface] (BETA) An array of up-sell products.
url_key - String (BETA) The part of the URL that identifies the product
url_path - String Use product's canonical_url or url rewrites instead
url_rewrites - [UrlRewrite] (BETA) URL rewrites list
url_suffix - String (BETA) The part of the product URL that is appended after the url key
variants - [ConfigurableVariant] (BETA) An array of simple product variants.
websites - [Website] (BETA) An array of websites in which the product is available. The field should not be used on the storefront.
weight - Float (BETA) The weight of the item, in units defined by the store.
Example
{
  "activity": "xyz789",
  "attribute_set_id": 987,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "category_gear": "abc123",
  "climate": "xyz789",
  "collar": "abc123",
  "color": 987,
  "configurable_options": [ConfigurableProductOptions],
  "configurable_product_options_selection": ConfigurableProductOptionsSelection,
  "country_of_manufacture": "abc123",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "description": ComplexTextValue,
  "eco_collection": 123,
  "erin_recommends": 987,
  "features_bags": "xyz789",
  "format": 987,
  "gender": "xyz789",
  "gift_message_available": "abc123",
  "id": 987,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "manufacturer": 987,
  "material": "xyz789",
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "abc123",
  "name": "xyz789",
  "new": 987,
  "new_from_date": "abc123",
  "new_to_date": "xyz789",
  "only_x_left_in_stock": 987.65,
  "options": [CustomizableOptionInterface],
  "options_container": "xyz789",
  "pattern": "abc123",
  "performance_fabric": 123,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 123,
  "rating_summary": 987.65,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 123,
  "reviews": ProductReviews,
  "sale": 987,
  "short_description": ComplexTextValue,
  "size": 987,
  "sku": "xyz789",
  "sleeve": "abc123",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 987.65,
  "special_to_date": "abc123",
  "staged": false,
  "stock_status": "IN_STOCK",
  "strap_bags": "abc123",
  "style_bags": "xyz789",
  "style_bottom": "abc123",
  "style_general": "xyz789",
  "swatch_image": "abc123",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "abc123",
  "uid": 4,
  "updated_at": "abc123",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "xyz789",
  "variants": [ConfigurableVariant],
  "websites": [Website],
  "weight": 123.45
}

ConfigurableProductCartItemInput

Fields
Input Field Description
customizable_options - [CustomizableOptionInput]

(BETA) The ID and value of the option.

data - CartItemInput!

(BETA) The quantity and SKU of the configurable product.

parent_sku - String

(BETA) The SKU of the parent configurable product.

variant_sku - String

(BETA) Deprecated. Use CartItemInput.sku instead.

Example
{
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput,
  "parent_sku": "abc123",
  "variant_sku": "abc123"
}

ConfigurableProductOption

Description

(BETA) Contains details about configurable product options.

Fields
Field Name Description
attribute_code - String! (BETA) An attribute code that uniquely identifies a configurable option.
label - String! (BETA) The display name of the option.
uid - ID! (BETA) The unique ID of the configurable option.
values - [ConfigurableProductOptionValue] (BETA) An array of values that are applicable for this option.
Example
{
  "attribute_code": "abc123",
  "label": "xyz789",
  "uid": "4",
  "values": [ConfigurableProductOptionValue]
}

ConfigurableProductOptionValue

Description

(BETA) Defines a value for a configurable product option.

Fields
Field Name Description
is_available - Boolean! (BETA) Indicates whether the product is available with this selected option.
is_use_default - Boolean! (BETA) Indicates whether the value is the default.
label - String! (BETA) The display name of the value.
swatch - SwatchDataInterface (BETA) The URL assigned to the thumbnail of the swatch image.
uid - ID! (BETA) The unique ID of the value.
Example
{
  "is_available": true,
  "is_use_default": false,
  "label": "abc123",
  "swatch": SwatchDataInterface,
  "uid": 4
}

ConfigurableProductOptions

Description

(BETA) Defines configurable attributes for the specified product.

Fields
Field Name Description
attribute_code - String (BETA) A string that identifies the attribute.
attribute_id - String (BETA) The ID assigned to the attribute. Use attribute_uid instead.
attribute_id_v2 - Int (BETA) The ID assigned to the attribute. Use attribute_uid instead.
attribute_uid - ID! (BETA) The unique ID for an Attribute object.
id - Int (BETA) The configurable option ID number assigned by the system. Use uid instead.
label - String (BETA) A displayed string that describes the configurable product option.
position - Int (BETA) A number that indicates the order in which the attribute is displayed.
product_id - Int (BETA) This is the same as a product's id field. product_id is not needed and can be obtained from its parent.
uid - ID! (BETA) The unique ID for a ConfigurableProductOptions object.
use_default - Boolean (BETA) Indicates whether the option is the default.
values - [ConfigurableProductOptionsValues] (BETA) An array that defines the value_index codes assigned to the configurable product.
Example
{
  "attribute_code": "xyz789",
  "attribute_id": "xyz789",
  "attribute_id_v2": 987,
  "attribute_uid": "4",
  "id": 123,
  "label": "abc123",
  "position": 123,
  "product_id": 987,
  "uid": "4",
  "use_default": false,
  "values": [ConfigurableProductOptionsValues]
}

ConfigurableProductOptionsSelection

Description

(BETA) Contains metadata corresponding to the selected configurable options.

Fields
Field Name Description
configurable_options - [ConfigurableProductOption] (BETA) An array of all possible configurable options.
media_gallery - [MediaGalleryInterface] (BETA) Product images and videos corresponding to the specified configurable options selection.
options_available_for_selection - [ConfigurableOptionAvailableForSelection] (BETA) The configurable options available for further selection based on the current selection.
variant - SimpleProduct (BETA) A variant represented by the specified configurable options selection. The value is expected to be null until selections are made for each configurable option.
Example
{
  "configurable_options": [ConfigurableProductOption],
  "media_gallery": [MediaGalleryInterface],
  "options_available_for_selection": [
    ConfigurableOptionAvailableForSelection
  ],
  "variant": SimpleProduct
}

ConfigurableProductOptionsValues

Description

(BETA) Contains the index number assigned to a configurable product option.

Fields
Field Name Description
default_label - String (BETA) The label of the product on the default store.
label - String (BETA) The label of the product.
store_label - String (BETA) The label of the product on the current store.
swatch_data - SwatchDataInterface (BETA) Swatch data for a configurable product option.
uid - ID (BETA) The unique ID for a ConfigurableProductOptionsValues object.
use_default_value - Boolean (BETA) Indicates whether to use the default_label.
value_index - Int (BETA) A unique index number assigned to the configurable product option. Use uid instead.
Example
{
  "default_label": "xyz789",
  "label": "abc123",
  "store_label": "abc123",
  "swatch_data": SwatchDataInterface,
  "uid": "4",
  "use_default_value": false,
  "value_index": 123
}

ConfigurableRequisitionListItem

Description

(BETA) Contains details about configurable products added to a requisition list.

Fields
Field Name Description
configurable_options - [SelectedConfigurableOption] (BETA) Selected configurable options for an item in the requisition list.
customizable_options - [SelectedCustomizableOption]! (BETA) Selected custom options for an item in the requisition list.
product - ProductInterface! (BETA) Details about a requisition list item.
quantity - Float! (BETA) The quantity of the product added to the requisition list.
uid - ID! (BETA) The unique ID of an item in a requisition list.
Example
{
  "configurable_options": [SelectedConfigurableOption],
  "customizable_options": [SelectedCustomizableOption],
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": "4"
}

ConfigurableVariant

Description

(BETA) Contains all the simple product variants of a configurable product.

Fields
Field Name Description
attributes - [ConfigurableAttributeOption] (BETA) An array of configurable attribute options.
product - SimpleProduct (BETA) An array of linked simple products.
Example
{
  "attributes": [ConfigurableAttributeOption],
  "product": SimpleProduct
}

ConfigurableWishlistItem

Description

(BETA) A configurable product wish list item.

Fields
Field Name Description
added_at - String! (BETA) The date and time the item was added to the wish list.
child_sku - String! (BETA) The SKU of the simple product corresponding to a set of selected configurable options. Use ConfigurableWishlistItem.configured_variant.sku instead.
configurable_options - [SelectedConfigurableOption] (BETA) An array of selected configurable options.
configured_variant - ProductInterface (BETA) Product details of the selected variant. The value is null if some options are not configured.
customizable_options - [SelectedCustomizableOption]! (BETA) Custom options selected for the wish list item.
description - String (BETA) The description of the item.
id - ID! (BETA) The unique ID for a WishlistItemInterface object.
product - ProductInterface (BETA) Product details of the wish list item.
quantity - Float! (BETA) The quantity of this wish list item.
Example
{
  "added_at": "xyz789",
  "child_sku": "xyz789",
  "configurable_options": [SelectedConfigurableOption],
  "configured_variant": ProductInterface,
  "customizable_options": [SelectedCustomizableOption],
  "description": "abc123",
  "id": 4,
  "product": ProductInterface,
  "quantity": 987.65
}

CopyItemsBetweenRequisitionListsInput

Description

(BETA) An input object that defines the items in a requisition list to be copied.

Fields
Input Field Description
requisitionListItemUids - [ID]!

(BETA) An array of IDs representing products copied from one requisition list to another.

Example
{"requisitionListItemUids": ["4"]}

CopyItemsFromRequisitionListsOutput

Description

(BETA) Output of the request to copy items to the destination requisition list.

Fields
Field Name Description
requisition_list - RequisitionList (BETA) The destination requisition list after the items were copied.
Example
{"requisition_list": RequisitionList}

CopyProductsBetweenWishlistsOutput

Description

(BETA) Contains the source and target wish lists after copying products.

Fields
Field Name Description
destination_wishlist - Wishlist! (BETA) The destination wish list containing the copied products.
source_wishlist - Wishlist! (BETA) The wish list that the products were copied from.
user_errors - [WishListUserInputError]! (BETA) An array of errors encountered while copying products in a wish list.
Example
{
  "destination_wishlist": Wishlist,
  "source_wishlist": Wishlist,
  "user_errors": [WishListUserInputError]
}

Country

Fields
Field Name Description
available_regions - [Region] (BETA) An array of regions within a particular country.
full_name_english - String (BETA) The name of the country in English.
full_name_locale - String (BETA) The name of the country in the current locale.
id - String (BETA) The unique ID for a Country object.
three_letter_abbreviation - String (BETA) The three-letter abbreviation of the country, such as USA.
two_letter_abbreviation - String (BETA) The two-letter abbreviation of the country, such as US.
Example
{
  "available_regions": [Region],
  "full_name_english": "abc123",
  "full_name_locale": "xyz789",
  "id": "abc123",
  "three_letter_abbreviation": "abc123",
  "two_letter_abbreviation": "abc123"
}

CountryCodeEnum

Description

(BETA) The list of country codes.

Values
Enum Value Description

AF

(BETA) Afghanistan

AX

Åland Islands

AL

(BETA) Albania

DZ

(BETA) Algeria

AS

(BETA) American Samoa

AD

(BETA) Andorra

AO

(BETA) Angola

AI

(BETA) Anguilla

AQ

(BETA) Antarctica

AG

(BETA) Antigua & Barbuda

AR

(BETA) Argentina

AM

(BETA) Armenia

AW

(BETA) Aruba

AU

(BETA) Australia

AT

(BETA) Austria

AZ

(BETA) Azerbaijan

BS

(BETA) Bahamas

BH

(BETA) Bahrain

BD

(BETA) Bangladesh

BB

(BETA) Barbados

BY

(BETA) Belarus

BE

(BETA) Belgium

BZ

(BETA) Belize

BJ

(BETA) Benin

BM

(BETA) Bermuda

BT

(BETA) Bhutan

BO

(BETA) Bolivia

BA

(BETA) Bosnia & Herzegovina

BW

(BETA) Botswana

BV

(BETA) Bouvet Island

BR

(BETA) Brazil

IO

(BETA) British Indian Ocean Territory

VG

(BETA) British Virgin Islands

BN

(BETA) Brunei

BG

(BETA) Bulgaria

BF

(BETA) Burkina Faso

BI

(BETA) Burundi

KH

(BETA) Cambodia

CM

(BETA) Cameroon

CA

(BETA) Canada

CV

(BETA) Cape Verde

KY

(BETA) Cayman Islands

CF

(BETA) Central African Republic

TD

(BETA) Chad

CL

(BETA) Chile

CN

(BETA) China

CX

(BETA) Christmas Island

CC

(BETA) Cocos (Keeling) Islands

CO

(BETA) Colombia

KM

(BETA) Comoros

CG

(BETA) Congo-Brazzaville

CD

(BETA) Congo-Kinshasa

CK

(BETA) Cook Islands

CR

(BETA) Costa Rica

CI

(BETA) Côte d’Ivoire

HR

(BETA) Croatia

CU

(BETA) Cuba

CY

(BETA) Cyprus

CZ

(BETA) Czech Republic

DK

(BETA) Denmark

DJ

(BETA) Djibouti

DM

(BETA) Dominica

DO

(BETA) Dominican Republic

EC

(BETA) Ecuador

EG

(BETA) Egypt

SV

(BETA) El Salvador

GQ

(BETA) Equatorial Guinea

ER

(BETA) Eritrea

EE

(BETA) Estonia

ET

(BETA) Ethiopia

FK

(BETA) Falkland Islands

FO

(BETA) Faroe Islands

FJ

(BETA) Fiji

FI

(BETA) Finland

FR

(BETA) France

GF

(BETA) French Guiana

PF

(BETA) French Polynesia

TF

(BETA) French Southern Territories

GA

(BETA) Gabon

GM

(BETA) Gambia

GE

(BETA) Georgia

DE

(BETA) Germany

GH

(BETA) Ghana

GI

(BETA) Gibraltar

GR

(BETA) Greece

GL

(BETA) Greenland

GD

(BETA) Grenada

GP

(BETA) Guadeloupe

GU

(BETA) Guam

GT

(BETA) Guatemala

GG

(BETA) Guernsey

GN

(BETA) Guinea

GW

(BETA) Guinea-Bissau

GY

(BETA) Guyana

HT

(BETA) Haiti

HM

(BETA) Heard & McDonald Islands

HN

(BETA) Honduras

HK

(BETA) Hong Kong SAR China

HU

(BETA) Hungary

IS

(BETA) Iceland

IN

(BETA) India

ID

(BETA) Indonesia

IR

(BETA) Iran

IQ

(BETA) Iraq

IE

(BETA) Ireland

IM

(BETA) Isle of Man

IL

(BETA) Israel

IT

(BETA) Italy

JM

(BETA) Jamaica

JP

(BETA) Japan

JE

(BETA) Jersey

JO

(BETA) Jordan

KZ

(BETA) Kazakhstan

KE

(BETA) Kenya

KI

(BETA) Kiribati

KW

(BETA) Kuwait

KG

(BETA) Kyrgyzstan

LA

(BETA) Laos

LV

(BETA) Latvia

LB

(BETA) Lebanon

LS

(BETA) Lesotho

LR

(BETA) Liberia

LY

(BETA) Libya

LI

(BETA) Liechtenstein

LT

(BETA) Lithuania

LU

(BETA) Luxembourg

MO

(BETA) Macau SAR China

MK

(BETA) Macedonia

MG

(BETA) Madagascar

MW

(BETA) Malawi

MY

(BETA) Malaysia

MV

(BETA) Maldives

ML

(BETA) Mali

MT

(BETA) Malta

MH

(BETA) Marshall Islands

MQ

(BETA) Martinique

MR

(BETA) Mauritania

MU

(BETA) Mauritius

YT

(BETA) Mayotte

MX

(BETA) Mexico

FM

(BETA) Micronesia

MD

(BETA) Moldova

MC

(BETA) Monaco

MN

(BETA) Mongolia

ME

(BETA) Montenegro

MS

(BETA) Montserrat

MA

(BETA) Morocco

MZ

(BETA) Mozambique

MM

(BETA) Myanmar (Burma)

NA

(BETA) Namibia

NR

(BETA) Nauru

NP

(BETA) Nepal

NL

(BETA) Netherlands

AN

(BETA) Netherlands Antilles

NC

(BETA) New Caledonia

NZ

(BETA) New Zealand

NI

(BETA) Nicaragua

NE

(BETA) Niger

NG

(BETA) Nigeria

NU

(BETA) Niue

NF

(BETA) Norfolk Island

MP

(BETA) Northern Mariana Islands

KP

(BETA) North Korea

NO

(BETA) Norway

OM

(BETA) Oman

PK

(BETA) Pakistan

PW

(BETA) Palau

PS

(BETA) Palestinian Territories

PA

(BETA) Panama

PG

(BETA) Papua New Guinea

PY

(BETA) Paraguay

PE

(BETA) Peru

PH

(BETA) Philippines

PN

(BETA) Pitcairn Islands

PL

(BETA) Poland

PT

(BETA) Portugal

QA

(BETA) Qatar

RE

(BETA) Réunion

RO

(BETA) Romania

RU

(BETA) Russia

RW

(BETA) Rwanda

WS

(BETA) Samoa

SM

(BETA) San Marino

ST

(BETA) São Tomé & Príncipe

SA

(BETA) Saudi Arabia

SN

(BETA) Senegal

RS

(BETA) Serbia

SC

(BETA) Seychelles

SL

(BETA) Sierra Leone

SG

(BETA) Singapore

SK

(BETA) Slovakia

SI

(BETA) Slovenia

SB

(BETA) Solomon Islands

SO

(BETA) Somalia

ZA

(BETA) South Africa

GS

(BETA) South Georgia & South Sandwich Islands

KR

(BETA) South Korea

ES

(BETA) Spain

LK

(BETA) Sri Lanka

BL

(BETA) St. Barthélemy

SH

(BETA) St. Helena

KN

(BETA) St. Kitts & Nevis

LC

(BETA) St. Lucia

MF

(BETA) St. Martin

PM

(BETA) St. Pierre & Miquelon

VC

(BETA) St. Vincent & Grenadines

SD

(BETA) Sudan

SR

(BETA) Suriname

SJ

(BETA) Svalbard & Jan Mayen

SZ

(BETA) Swaziland

SE

(BETA) Sweden

CH

(BETA) Switzerland

SY

(BETA) Syria

TW

(BETA) Taiwan

TJ

(BETA) Tajikistan

TZ

(BETA) Tanzania

TH

(BETA) Thailand

TL

(BETA) Timor-Leste

TG

(BETA) Togo

TK

(BETA) Tokelau

TO

(BETA) Tonga

TT

(BETA) Trinidad & Tobago

TN

(BETA) Tunisia

TR

(BETA) Turkey

TM

(BETA) Turkmenistan

TC

(BETA) Turks & Caicos Islands

TV

(BETA) Tuvalu

UG

(BETA) Uganda

UA

(BETA) Ukraine

AE

(BETA) United Arab Emirates

GB

(BETA) United Kingdom

US

(BETA) United States

UY

(BETA) Uruguay

UM

(BETA) U.S. Outlying Islands

VI

(BETA) U.S. Virgin Islands

UZ

(BETA) Uzbekistan

VU

(BETA) Vanuatu

VA

(BETA) Vatican City

VE

(BETA) Venezuela

VN

(BETA) Vietnam

WF

(BETA) Wallis & Futuna

EH

(BETA) Western Sahara

YE

(BETA) Yemen

ZM

(BETA) Zambia

ZW

(BETA) Zimbabwe
Example
"AF"

CreateCompanyOutput

Description

(BETA) Contains the response to the request to create a company.

Fields
Field Name Description
company - Company! (BETA) The new company instance.
Example
{"company": Company}

CreateCompanyRoleOutput

Description

(BETA) Contains the response to the request to create a company role.

Fields
Field Name Description
role - CompanyRole! (BETA) The new company role instance.
Example
{"role": CompanyRole}

CreateCompanyTeamOutput

Description

(BETA) Contains the response to the request to create a company team.

Fields
Field Name Description
team - CompanyTeam! (BETA) The new company team instance.
Example
{"team": CompanyTeam}

CreateCompanyUserOutput

Description

(BETA) Contains the response to the request to create a company user.

Fields
Field Name Description
user - Customer! (BETA) The new company user instance.
Example
{"user": Customer}

CreateCompareListInput

Description

(BETA) Contains an array of product IDs to use for creating a compare list.

Fields
Input Field Description
products - [ID]

(BETA) An array of product IDs to add to the compare list.

Example
{"products": ["4"]}

CreateGiftRegistryInput

Description

(BETA) Defines a new gift registry.

Fields
Input Field Description
dynamic_attributes - [GiftRegistryDynamicAttributeInput]

(BETA) Additional attributes specified as a code-value pair.

event_name - String!

(BETA) The name of the event.

gift_registry_type_uid - ID!

(BETA) The ID of the selected event type.

message - String!

(BETA) A message describing the event.

privacy_settings - GiftRegistryPrivacySettings!

(BETA) Indicates whether the registry is PRIVATE or PUBLIC.

registrants - [AddGiftRegistryRegistrantInput]!

(BETA) The list of people who receive notifications about the registry.

shipping_address - GiftRegistryShippingAddressInput

(BETA) The shipping address for all gift registry items.

status - GiftRegistryStatus!

(BETA) Indicates whether the registry is ACTIVE or INACTIVE.

Example
{
  "dynamic_attributes": [
    GiftRegistryDynamicAttributeInput
  ],
  "event_name": "abc123",
  "gift_registry_type_uid": 4,
  "message": "xyz789",
  "privacy_settings": "PRIVATE",
  "registrants": [AddGiftRegistryRegistrantInput],
  "shipping_address": GiftRegistryShippingAddressInput,
  "status": "ACTIVE"
}

CreateGiftRegistryOutput

Description

(BETA) Contains the results of a request to create a gift registry.

Fields
Field Name Description
gift_registry - GiftRegistry (BETA) The newly-created gift registry.
Example
{"gift_registry": GiftRegistry}

CreatePayflowProTokenOutput

Description

(BETA) Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods.

Fields
Field Name Description
response_message - String! (BETA) The RESPMSG returned by PayPal. If the result is 0, then response_message is Approved.
result - Int! (BETA) A non-zero value if any errors occurred.
result_code - Int! (BETA) The RESULT returned by PayPal. A value of 0 indicates the transaction was approved.
secure_token - String! (BETA) A secure token generated by PayPal.
secure_token_id - String! (BETA) A secure token ID generated by PayPal.
Example
{
  "response_message": "xyz789",
  "result": 123,
  "result_code": 123,
  "secure_token": "xyz789",
  "secure_token_id": "xyz789"
}

CreateProductReviewInput

Description

(BETA) Defines a new product review.

Fields
Input Field Description
nickname - String!

(BETA) The customer's nickname. Defaults to the customer name, if logged in.

ratings - [ProductReviewRatingInput]!

(BETA) The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc.

sku - String!

(BETA) The SKU of the reviewed product.

summary - String!

(BETA) The summary (title) of the review.

text - String!

(BETA) The review text.

Example
{
  "nickname": "xyz789",
  "ratings": [ProductReviewRatingInput],
  "sku": "abc123",
  "summary": "xyz789",
  "text": "xyz789"
}

CreateProductReviewOutput

Description

(BETA) Contains the completed product review.

Fields
Field Name Description
review - ProductReview! (BETA) Product review details.
Example
{"review": ProductReview}

CreatePurchaseOrderApprovalRuleConditionAmountInput

Description

(BETA) Specifies the amount and currency to evaluate.

Fields
Input Field Description
currency - CurrencyEnum!

(BETA) Purchase order approval rule condition amount currency.

value - Float!

(BETA) Purchase order approval rule condition amount value.

Example
{"currency": "AFN", "value": 123.45}

CreatePurchaseOrderApprovalRuleConditionInput

Description

(BETA) Defines a set of conditions that apply to a rule.

Fields
Input Field Description
amount - CreatePurchaseOrderApprovalRuleConditionAmountInput

(BETA) The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity.

attribute - PurchaseOrderApprovalRuleType!

(BETA) The type of approval rule.

operator - PurchaseOrderApprovalRuleConditionOperator!

(BETA) Defines how to evaluate an amount or quantity in a purchase order.

quantity - Int

(BETA) The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount.

Example
{
  "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput,
  "attribute": "GRAND_TOTAL",
  "operator": "MORE_THAN",
  "quantity": 987
}

CreateRequisitionListInput

Description

(BETA) An input object that identifies and describes a new requisition list.

Fields
Input Field Description
description - String

(BETA) An optional description of the requisition list.

name - String!

(BETA) The name assigned to the requisition list.

Example
{
  "description": "xyz789",
  "name": "xyz789"
}

CreateRequisitionListOutput

Description

(BETA) Output of the request to create a requisition list.

Fields
Field Name Description
requisition_list - RequisitionList (BETA) The created requisition list.
Example
{"requisition_list": RequisitionList}

CreateWishlistInput

Description

(BETA) Defines the name and visibility of a new wish list.

Fields
Input Field Description
name - String!

(BETA) The name of the new wish list.

visibility - WishlistVisibilityEnum!

(BETA) Indicates whether the wish list is public or private.

Example
{"name": "xyz789", "visibility": "PUBLIC"}

CreateWishlistOutput

Description

(BETA) Contains the wish list.

Fields
Field Name Description
wishlist - Wishlist! (BETA) The newly-created wish list
Example
{"wishlist": Wishlist}

CreditCardDetailsInput

Description

(BETA) Required fields for Payflow Pro and Payments Pro credit card payments.

Fields
Input Field Description
cc_exp_month - Int!

(BETA) The credit card expiration month.

cc_exp_year - Int!

(BETA) The credit card expiration year.

cc_last_4 - Int!

(BETA) The last 4 digits of the credit card.

cc_type - String!

(BETA) The credit card type.

Example
{
  "cc_exp_month": 987,
  "cc_exp_year": 123,
  "cc_last_4": 123,
  "cc_type": "xyz789"
}

CreditMemo

Description

(BETA) Contains credit memo details.

Fields
Field Name Description
comments - [SalesCommentItem] (BETA) Comments on the credit memo.
id - ID! (BETA) The unique ID for a CreditMemo object.
items - [CreditMemoItemInterface] (BETA) An array containing details about refunded items.
number - String! (BETA) The sequential credit memo number.
total - CreditMemoTotal (BETA) Details about the total refunded amount.
Example
{
  "comments": [SalesCommentItem],
  "id": 4,
  "items": [CreditMemoItemInterface],
  "number": "abc123",
  "total": CreditMemoTotal
}

CreditMemoItem

Fields
Field Name Description
discounts - [Discount] (BETA) Details about the final discount amount for the base product, including discounts on options.
id - ID! (BETA) The unique ID for a CreditMemoItemInterface object.
order_item - OrderItemInterface (BETA) The order item the credit memo is applied to.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product, including selected options.
product_sku - String! (BETA) The SKU of the base product.
quantity_refunded - Float (BETA) The number of refunded items.
Example
{
  "discounts": [Discount],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_refunded": 123.45
}

CreditMemoItemInterface

Description

(BETA) Credit memo item details.

Fields
Field Name Description
discounts - [Discount] (BETA) Details about the final discount amount for the base product, including discounts on options.
id - ID! (BETA) The unique ID for a CreditMemoItemInterface object.
order_item - OrderItemInterface (BETA) The order item the credit memo is applied to.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product, including selected options.
product_sku - String! (BETA) The SKU of the base product.
quantity_refunded - Float (BETA) The number of refunded items.
Example
{
  "discounts": [Discount],
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_refunded": 987.65
}

CreditMemoTotal

Description

(BETA) Contains credit memo price details.

Fields
Field Name Description
adjustment - Money! (BETA) An adjustment manually applied to the order.
base_grand_total - Money! (BETA) The final base grand total amount in the base currency.
discounts - [Discount] (BETA) The applied discounts to the credit memo.
grand_total - Money! (BETA) The final total amount, including shipping, discounts, and taxes.
shipping_handling - ShippingHandling (BETA) Details about the shipping and handling costs for the credit memo.
subtotal - Money! (BETA) The subtotal of the invoice, excluding shipping, discounts, and taxes.
taxes - [TaxItem] (BETA) The credit memo tax details.
total_shipping - Money! (BETA) The shipping amount for the credit memo.
total_tax - Money! (BETA) The amount of tax applied to the credit memo.
Example
{
  "adjustment": Money,
  "base_grand_total": Money,
  "discounts": [Discount],
  "grand_total": Money,
  "shipping_handling": ShippingHandling,
  "subtotal": Money,
  "taxes": [TaxItem],
  "total_shipping": Money,
  "total_tax": Money
}

Currency

Fields
Field Name Description
available_currency_codes - [String] (BETA) An array of three-letter currency codes accepted by the store, such as USD and EUR.
base_currency_code - String (BETA) The base currency set for the store, such as USD.
base_currency_symbol - String (BETA) The symbol for the specified base currency, such as $.
default_display_currecy_code - String Symbol was missed. Use default_display_currency_code.
default_display_currecy_symbol - String Symbol was missed. Use default_display_currency_code.
default_display_currency_code - String (BETA) The currency that is displayed by default, such as USD.
default_display_currency_symbol - String (BETA) The currency symbol that is displayed by default, such as $.
exchange_rates - [ExchangeRate] (BETA) An array of exchange rates for currencies defined in the store.
Example
{
  "available_currency_codes": ["xyz789"],
  "base_currency_code": "xyz789",
  "base_currency_symbol": "abc123",
  "default_display_currecy_code": "xyz789",
  "default_display_currecy_symbol": "abc123",
  "default_display_currency_code": "xyz789",
  "default_display_currency_symbol": "xyz789",
  "exchange_rates": [ExchangeRate]
}

CurrencyEnum

Description

(BETA) The list of available currency codes.

Values
Enum Value Description

AFN

ALL

AZN

DZD

AOA

ARS

AMD

AWG

AUD

BSD

BHD

BDT

BBD

BYN

BZD

BMD

BTN

BOB

BAM

BWP

BRL

GBP

BND

BGN

BUK

BIF

KHR

CAD

CVE

CZK

KYD

GQE

CLP

CNY

COP

KMF

CDF

CRC

HRK

CUP

DKK

DJF

DOP

XCD

EGP

SVC

ERN

EEK

ETB

EUR

FKP

FJD

GMD

GEK

GEL

GHS

GIP

GTQ

GNF

GYD

HTG

HNL

HKD

HUF

ISK

INR

IDR

IRR

IQD

ILS

JMD

JPY

JOD

KZT

KES

KWD

KGS

LAK

LVL

LBP

LSL

LRD

LYD

LTL

MOP

MKD

MGA

MWK

MYR

MVR

LSM

MRO

MUR

MXN

MDL

MNT

MAD

MZN

MMK

NAD

NPR

ANG

YTL

NZD

NIC

NGN

KPW

NOK

OMR

PKR

PAB

PGK

PYG

PEN

PHP

PLN

QAR

RHD

RON

RUB

RWF

SHP

STD

SAR

RSD

SCR

SLL

SGD

SKK

SBD

SOS

ZAR

KRW

LKR

SDG

SRD

SZL

SEK

CHF

SYP

TWD

TJS

TZS

THB

TOP

TTD

TND

TMM

USD

UGX

UAH

AED

UYU

UZS

VUV

VEB

VEF

VND

CHE

CHW

XOF

WST

YER

ZMK

ZWD

TRY

AZM

ROL

TRL

XPF

Example
"AFN"

CustomAttributeMetadata

Description

(BETA) Defines an array of custom attributes.

Fields
Field Name Description
items - [Attribute] (BETA) An array of attributes.
Example
{"items": [Attribute]}

Customer

Description

(BETA) Defines the customer name, addresses, and other details.

Fields
Field Name Description
addresses - [CustomerAddress] (BETA) An array containing the customer's shipping and billing addresses.
allow_remote_shopping_assistance - Boolean! (BETA) Indicates whether the customer has enabled remote shopping assistance.
compare_list - CompareList (BETA) The contents of the customer's compare list.
created_at - String (BETA) Timestamp indicating when the account was created.
date_of_birth - String (BETA) The customer's date of birth.
default_billing - String (BETA) The ID assigned to the billing address.
default_shipping - String (BETA) The ID assigned to the shipping address.
dob - String (BETA) The customer's date of birth. Use date_of_birth instead.
email - String (BETA) The customer's email address. Required.
firstname - String (BETA) The customer's first name.
gender - Int (BETA) The customer's gender (Male - 1, Female - 2).
gift_registries - [GiftRegistry] (BETA) Details about all of the customer's gift registries.
gift_registry - GiftRegistry (BETA) Details about a specific gift registry.
Arguments
giftRegistryUid - ID!
group_id - Int Customer group should not be exposed in the storefront scenarios.
id - Int (BETA) The ID assigned to the customer. id is not needed as part of Customer, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side.
is_subscribed - Boolean (BETA) Indicates whether the customer is subscribed to the company's newsletter.
job_title - String (BETA) The job title of a company user.
lastname - String (BETA) The customer's family name.
middlename - String (BETA) The customer's middle name.
orders - CustomerOrders
Arguments
filter - CustomerOrdersFilterInput

(BETA) Defines the filter to use for searching customer orders.

currentPage - Int

(BETA) Specifies which page of results to return. The default value is 1.

pageSize - Int

(BETA) Specifies the maximum number of results to return at once. The default value is 20.

sort - CustomerOrderSortInput

(BETA) Specifies which field to sort on, and whether to return the results in ascending or descending order.

scope - ScopeTypeEnum

(BETA) Specifies the scope to search for customer orders. The Store request header identifies the customer's store view code. The default value of STORE limits the search to the value specified in the header. Specify WEBSITE to expand the search to include all customer orders assigned to the website that is defined in the header, or specify GLOBAL to include all customer orders across all websites and stores.

prefix - String (BETA) An honorific, such as Dr., Mr., or Mrs.
purchase_order - PurchaseOrder (BETA) Purchase order details.
Arguments
uid - ID!
purchase_order_approval_rule - PurchaseOrderApprovalRule (BETA) Details about a single purchase order approval rule.
Arguments
uid - ID!
purchase_order_approval_rule_metadata - PurchaseOrderApprovalRuleMetadata (BETA) Purchase order approval rule metadata that can be used for rule edit form rendering.
purchase_order_approval_rules - PurchaseOrderApprovalRules (BETA) A list of purchase order approval rules visible to the customer.
Arguments
currentPage - Int
pageSize - Int
purchase_orders - PurchaseOrders (BETA) A list of purchase orders visible to the customer.
Arguments
currentPage - Int
pageSize - Int
purchase_orders_enabled - Boolean! (BETA) Indicates whether purchase order functionality is enabled for the current customer. Global and company-level settings are factored into the result.
requisition_lists - RequisitionLists (BETA) An object that contains the customer's requisition lists.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default value is 20.

currentPage - Int

(BETA) The page of results to return. The default value is 1.

filter - RequisitionListFilterInput

(BETA) The filter to use to limit the number of requisition lists to return.

return - Return (BETA) Details about the specified return request from the unique ID for a Return object.
Arguments
uid - ID!
returns - Returns (BETA) Information about the customer's return requests.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default is 20.

currentPage - Int

(BETA) The page of results to return. The default is 1.

reviews - ProductReviews! (BETA) Contains the customer's product reviews.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default value is 20.

currentPage - Int

(BETA) The page of results to return. The default value is 1.

reward_points - RewardPoints (BETA) Customer reward points details.
role - CompanyRole (BETA) The role name and permissions assigned to the company user.
status - CompanyUserStatusEnum (BETA) Indicates whether the company user is ACTIVE or INACTIVE.
store_credit - CustomerStoreCredit (BETA) Store credit information applied for the logged in customer.
structure_id - ID! (BETA) ID of the company structure
suffix - String (BETA) A value such as Sr., Jr., or III.
taxvat - String (BETA) The customer's Value-added tax (VAT) number (for corporate customers).
team - CompanyTeam (BETA) The team the company user is assigned to.
telephone - String (BETA) The phone number of the company user.
wishlist - Wishlist! (BETA) Return a customer's wish lists. Use Customer.wishlists or Customer.wishlist_v2 instead.
wishlist_v2 - Wishlist (BETA) Retrieve the wish list identified by the unique ID for a Wishlist object.
Arguments
id - ID!
wishlists - [Wishlist]! (BETA) An array of wishlists. In Magento Open Source, customers are limited to one wish list. The number of wish lists is configurable for Adobe Commerce.
Arguments
pageSize - Int

(BETA) Specifies the maximum number of results to return at once. This attribute is optional.

currentPage - Int

(BETA) Specifies which page of results to return. The default value is 1.

Example
{
  "addresses": [CustomerAddress],
  "allow_remote_shopping_assistance": true,
  "compare_list": CompareList,
  "created_at": "abc123",
  "date_of_birth": "xyz789",
  "default_billing": "xyz789",
  "default_shipping": "abc123",
  "dob": "xyz789",
  "email": "abc123",
  "firstname": "abc123",
  "gender": 123,
  "gift_registries": [GiftRegistry],
  "gift_registry": GiftRegistry,
  "group_id": 987,
  "id": 123,
  "is_subscribed": true,
  "job_title": "abc123",
  "lastname": "abc123",
  "middlename": "xyz789",
  "orders": CustomerOrders,
  "prefix": "xyz789",
  "purchase_order": PurchaseOrder,
  "purchase_order_approval_rule": PurchaseOrderApprovalRule,
  "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
  "purchase_order_approval_rules": PurchaseOrderApprovalRules,
  "purchase_orders": PurchaseOrders,
  "purchase_orders_enabled": false,
  "requisition_lists": RequisitionLists,
  "return": Return,
  "returns": Returns,
  "reviews": ProductReviews,
  "reward_points": RewardPoints,
  "role": CompanyRole,
  "status": "ACTIVE",
  "store_credit": CustomerStoreCredit,
  "structure_id": 4,
  "suffix": "abc123",
  "taxvat": "xyz789",
  "team": CompanyTeam,
  "telephone": "abc123",
  "wishlist": Wishlist,
  "wishlist_v2": Wishlist,
  "wishlists": [Wishlist]
}

CustomerAddress

Description

(BETA) Contains detailed information about a customer's billing or shipping address.

Fields
Field Name Description
city - String (BETA) The customer's city or town.
company - String (BETA) The customer's company.
country_code - CountryCodeEnum (BETA) The customer's country.
country_id - String (BETA) The customer's country. Use country_code instead.
custom_attributes - [CustomerAddressAttribute] Custom attributes should not be put into a container.
customer_id - Int (BETA) The customer ID customer_id is not needed as part of CustomerAddress. The id is a unique identifier for the addresses.
default_billing - Boolean (BETA) Indicates whether the address is the customer's default billing address.
default_shipping - Boolean (BETA) Indicates whether the address is the customer's default shipping address.
extension_attributes - [CustomerAddressAttribute] (BETA) Contains any extension attributes for the address.
fax - String (BETA) The customer's fax number.
firstname - String (BETA) The first name of the person associated with the shipping/billing address.
id - Int (BETA) The ID of a CustomerAddress object.
lastname - String (BETA) The family name of the person associated with the shipping/billing address.
middlename - String (BETA) The middle name of the person associated with the shipping/billing address.
postcode - String (BETA) The customer's ZIP or postal code.
prefix - String (BETA) An honorific, such as Dr., Mr., or Mrs.
region - CustomerAddressRegion (BETA) An object containing the region name, region code, and region ID.
region_id - Int (BETA) The unique ID for a pre-defined region.
street - [String] (BETA) An array of strings that define the street number and name.
suffix - String (BETA) A value such as Sr., Jr., or III.
telephone - String (BETA) The customer's telephone number.
vat_id - String (BETA) The customer's Value-added tax (VAT) number (for corporate customers).
Example
{
  "city": "xyz789",
  "company": "xyz789",
  "country_code": "AF",
  "country_id": "xyz789",
  "custom_attributes": [CustomerAddressAttribute],
  "customer_id": 123,
  "default_billing": false,
  "default_shipping": false,
  "extension_attributes": [CustomerAddressAttribute],
  "fax": "abc123",
  "firstname": "xyz789",
  "id": 123,
  "lastname": "abc123",
  "middlename": "xyz789",
  "postcode": "xyz789",
  "prefix": "xyz789",
  "region": CustomerAddressRegion,
  "region_id": 123,
  "street": ["abc123"],
  "suffix": "abc123",
  "telephone": "abc123",
  "vat_id": "abc123"
}

CustomerAddressAttribute

Description

(BETA) Specifies the attribute code and value of a customer address attribute.

Fields
Field Name Description
attribute_code - String (BETA) The name assigned to the customer address attribute.
value - String (BETA) The valuue assigned to the customer address attribute.
Example
{
  "attribute_code": "abc123",
  "value": "abc123"
}

CustomerAddressAttributeInput

Description

(BETA) Specifies the attribute code and value of a customer attribute.

Fields
Input Field Description
attribute_code - String!

(BETA) The name assigned to the attribute.

value - String!

(BETA) The value assigned to the attribute.

Example
{
  "attribute_code": "abc123",
  "value": "xyz789"
}

CustomerAddressInput

Description

(BETA) Contains details about a billing or shipping address.

Fields
Input Field Description
city - String

(BETA) The customer's city or town.

company - String

(BETA) The customer's company.

country_code - CountryCodeEnum

(BETA) The two-letter code representing the customer's country.

country_id - CountryCodeEnum

(BETA) Deprecated: use country_code instead.

custom_attributes - [CustomerAddressAttributeInput]

(BETA) Deprecated: Custom attributes should not be put into container.

default_billing - Boolean

(BETA) Indicates whether the address is the default billing address.

default_shipping - Boolean

(BETA) Indicates whether the address is the default shipping address.

fax - String

(BETA) The customer's fax number.

firstname - String

(BETA) The first name of the person associated with the billing/shipping address.

lastname - String

(BETA) The family name of the person associated with the billing/shipping address.

middlename - String

(BETA) The middle name of the person associated with the billing/shipping address.

postcode - String

(BETA) The customer's ZIP or postal code.

prefix - String

(BETA) An honorific, such as Dr., Mr., or Mrs.

region - CustomerAddressRegionInput

(BETA) An object containing the region name, region code, and region ID.

street - [String]

(BETA) An array of strings that define the street number and name.

suffix - String

(BETA) A value such as Sr., Jr., or III.

telephone - String

(BETA) The customer's telephone number.

vat_id - String

(BETA) The customer's Tax/VAT number (for corporate customers).

Example
{
  "city": "abc123",
  "company": "xyz789",
  "country_code": "AF",
  "country_id": "AF",
  "custom_attributes": [CustomerAddressAttributeInput],
  "default_billing": true,
  "default_shipping": true,
  "fax": "xyz789",
  "firstname": "abc123",
  "lastname": "abc123",
  "middlename": "abc123",
  "postcode": "abc123",
  "prefix": "abc123",
  "region": CustomerAddressRegionInput,
  "street": ["abc123"],
  "suffix": "abc123",
  "telephone": "abc123",
  "vat_id": "xyz789"
}

CustomerAddressRegion

Description

(BETA) Defines the customer's state or province.

Fields
Field Name Description
region - String (BETA) The state or province name.
region_code - String (BETA) The address region code.
region_id - Int (BETA) The unique ID for a pre-defined region.
Example
{
  "region": "xyz789",
  "region_code": "abc123",
  "region_id": 123
}

CustomerAddressRegionInput

Description

(BETA) Defines the customer's state or province.

Fields
Input Field Description
region - String

(BETA) The state or province name.

region_code - String

(BETA) The address region code.

region_id - Int

(BETA) The unique ID for a pre-defined region.

Example
{
  "region": "xyz789",
  "region_code": "abc123",
  "region_id": 123
}

CustomerCreateInput

Description

(BETA) An input object for creating a customer.

Fields
Input Field Description
allow_remote_shopping_assistance - Boolean

(BETA) Indicates whether the customer has enabled remote shopping assistance.

date_of_birth - String

(BETA) The customer's date of birth.

dob - String

(BETA) Deprecated: Use date_of_birth instead.

email - String!

(BETA) The customer's email address.

firstname - String!

(BETA) The customer's first name.

gender - Int

(BETA) The customer's gender (Male - 1, Female - 2).

is_subscribed - Boolean

(BETA) Indicates whether the customer is subscribed to the company's newsletter.

lastname - String!

(BETA) The customer's family name.

middlename - String

(BETA) The customer's middle name.

password - String

(BETA) The customer's password.

prefix - String

(BETA) An honorific, such as Dr., Mr., or Mrs.

suffix - String

(BETA) A value such as Sr., Jr., or III.

taxvat - String

(BETA) The customer's Tax/VAT number (for corporate customers).

Example
{
  "allow_remote_shopping_assistance": false,
  "date_of_birth": "xyz789",
  "dob": "xyz789",
  "email": "xyz789",
  "firstname": "abc123",
  "gender": 987,
  "is_subscribed": false,
  "lastname": "xyz789",
  "middlename": "abc123",
  "password": "abc123",
  "prefix": "xyz789",
  "suffix": "abc123",
  "taxvat": "abc123"
}

CustomerDownloadableProduct

Description

(BETA) Contains details about a single downloadable product.

Fields
Field Name Description
date - String (BETA) The date and time the purchase was made.
download_url - String (BETA) The fully qualified URL to the download file.
order_increment_id - String (BETA) The unique ID assigned to the item.
remaining_downloads - String (BETA) The remaining number of times the customer can download the product.
status - String (BETA) Indicates when the product becomes available for download. Options are Pending and Invoiced.
Example
{
  "date": "abc123",
  "download_url": "abc123",
  "order_increment_id": "abc123",
  "remaining_downloads": "abc123",
  "status": "abc123"
}

CustomerDownloadableProducts

Description

(BETA) Contains a list of downloadable products.

Fields
Field Name Description
items - [CustomerDownloadableProduct] (BETA) An array of purchased downloadable items.
Example
{"items": [CustomerDownloadableProduct]}

CustomerInput

Description

(BETA) An input object that assigns or updates customer attributes.

Fields
Input Field Description
date_of_birth - String

(BETA) The customer's date of birth.

dob - String

(BETA) Deprecated: Use date_of_birth instead.

email - String

(BETA) The customer's email address. Required when creating a customer.

firstname - String

(BETA) The customer's first name.

gender - Int

(BETA) The customer's gender (Male - 1, Female - 2).

is_subscribed - Boolean

(BETA) Indicates whether the customer is subscribed to the company's newsletter.

lastname - String

(BETA) The customer's family name.

middlename - String

(BETA) The customer's middle name.

password - String

(BETA) The customer's password.

prefix - String

(BETA) An honorific, such as Dr., Mr., or Mrs.

suffix - String

(BETA) A value such as Sr., Jr., or III.

taxvat - String

(BETA) The customer's Tax/VAT number (for corporate customers).

Example
{
  "date_of_birth": "xyz789",
  "dob": "xyz789",
  "email": "xyz789",
  "firstname": "abc123",
  "gender": 987,
  "is_subscribed": true,
  "lastname": "abc123",
  "middlename": "xyz789",
  "password": "abc123",
  "prefix": "abc123",
  "suffix": "abc123",
  "taxvat": "xyz789"
}

CustomerOrder

Description

(BETA) Contains details about each of the customer's orders.

Fields
Field Name Description
billing_address - OrderAddress (BETA) The billing address for the order.
carrier - String (BETA) The shipping carrier for the order delivery.
comments - [SalesCommentItem] (BETA) Comments about the order.
created_at - String Use the order_date field instead.
credit_memos - [CreditMemo] (BETA) A list of credit memos.
gift_message - GiftMessage (BETA) The entered gift message for the order
gift_receipt_included - Boolean! (BETA) Indicates whether the customer requested a gift receipt for the order.
gift_wrapping - GiftWrapping (BETA) The selected gift wrapping for the order.
grand_total - Float Use the totals.grand_total field instead.
id - ID! (BETA) The unique ID for a CustomerOrder object.
increment_id - String Use the id field instead.
invoices - [Invoice]! (BETA) A list of invoices for the order.
items - [OrderItemInterface] (BETA) An array containing the items purchased in this order.
items_eligible_for_return - [OrderItemInterface] (BETA) A list of order items eligible to be in a return request.
number - String! (BETA) The order number.
order_date - String! (BETA) The date the order was placed.
order_number - String! Use the number field instead.
payment_methods - [OrderPaymentMethod] (BETA) Payment details for the order.
printed_card_included - Boolean! (BETA) Indicates whether the customer requested a printed card for the order.
returns - Returns (BETA) Return requests associated with this order.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default is 20.

currentPage - Int

(BETA) The page of results to return. The default is 1.

shipments - [OrderShipment] (BETA) A list of shipments for the order.
shipping_address - OrderAddress (BETA) The shipping address for the order.
shipping_method - String (BETA) The delivery method for the order.
status - String! (BETA) The current status of the order.
total - OrderTotal (BETA) Details about the calculated totals for this order.
Example
{
  "billing_address": OrderAddress,
  "carrier": "abc123",
  "comments": [SalesCommentItem],
  "created_at": "abc123",
  "credit_memos": [CreditMemo],
  "gift_message": GiftMessage,
  "gift_receipt_included": true,
  "gift_wrapping": GiftWrapping,
  "grand_total": 123.45,
  "id": "4",
  "increment_id": "xyz789",
  "invoices": [Invoice],
  "items": [OrderItemInterface],
  "items_eligible_for_return": [OrderItemInterface],
  "number": "xyz789",
  "order_date": "abc123",
  "order_number": "abc123",
  "payment_methods": [OrderPaymentMethod],
  "printed_card_included": true,
  "returns": Returns,
  "shipments": [OrderShipment],
  "shipping_address": OrderAddress,
  "shipping_method": "xyz789",
  "status": "abc123",
  "total": OrderTotal
}

CustomerOrderSortInput

Description

(BETA) CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order.

Fields
Input Field Description
sort_direction - SortEnum!

(BETA) This enumeration indicates whether to return results in ascending or descending order

sort_field - CustomerOrderSortableField!

(BETA) Specifies the field to use for sorting

Example
{"sort_direction": "ASC", "sort_field": "NUMBER"}

CustomerOrderSortableField

Description

(BETA) Specifies the field to use for sorting

Values
Enum Value Description

NUMBER

(BETA) Sorts customer orders by number

CREATED_AT

(BETA) Sorts customer orders by created_at field
Example
"NUMBER"

CustomerOrders

Description

(BETA) The collection of orders that match the conditions defined in the filter.

Fields
Field Name Description
items - [CustomerOrder]! (BETA) An array of customer orders.
page_info - SearchResultPageInfo (BETA) Contains pagination metadata.
total_count - Int (BETA) The total count of customer orders.
Example
{
  "items": [CustomerOrder],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CustomerOrdersFilterInput

Description

(BETA) Identifies the filter to use for filtering orders.

Fields
Input Field Description
number - FilterStringTypeInput

(BETA) Filters by order number.

Example
{"number": FilterStringTypeInput}

CustomerOutput

Description

(BETA) Contains details about a newly-created or updated customer.

Fields
Field Name Description
customer - Customer! (BETA) Customer details after creating or updating a customer.
Example
{"customer": Customer}

CustomerPaymentTokens

Description

(BETA) Contains payment tokens stored in the customer's vault.

Fields
Field Name Description
items - [PaymentToken]! (BETA) An array of payment tokens.
Example
{"items": [PaymentToken]}

CustomerStoreCredit

Description

(BETA) Contains store credit information with balance and history.

Fields
Field Name Description
balance_history - CustomerStoreCreditHistory (BETA) Contains the customer's store credit balance history. If the history or store credit feature is disabled, then a null value will be returned.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default is 20.

currentPage - Int

(BETA) The page of results to return. This value is optional. The default is 1.

current_balance - Money (BETA) The current balance of store credit.
enabled - Boolean (BETA) Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned.
Example
{
  "balance_history": CustomerStoreCreditHistory,
  "current_balance": Money,
  "enabled": false
}

CustomerStoreCreditHistory

Description

(BETA) Lists changes to the amount of store credit available to the customer.

Fields
Field Name Description
items - [CustomerStoreCreditHistoryItem] (BETA) An array containing information about changes to the store credit available to the customer.
page_info - SearchResultPageInfo (BETA) Metadata for pagination rendering.
total_count - Int (BETA) The number of items returned.
Example
{
  "items": [CustomerStoreCreditHistoryItem],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CustomerStoreCreditHistoryItem

Description

(BETA) Contains store credit history information.

Fields
Field Name Description
action - String (BETA) The action that was made on the store credit.
actual_balance - Money (BETA) The store credit available to the customer as a result of this action.
balance_change - Money (BETA) The amount added to or subtracted from the store credit as a result of this action.
date_time_changed - String (BETA) The date and time when the store credit change was made.
Example
{
  "action": "xyz789",
  "actual_balance": Money,
  "balance_change": Money,
  "date_time_changed": "abc123"
}

CustomerToken

Description

(BETA) Contains a customer authorization token.

Fields
Field Name Description
token - String (BETA) The customer authorization token.
Example
{"token": "xyz789"}

CustomerUpdateInput

Description

(BETA) An input object for updating a customer.

Fields
Input Field Description
allow_remote_shopping_assistance - Boolean

(BETA) Indicates whether the customer has enabled remote shopping assistance.

date_of_birth - String

(BETA) The customer's date of birth.

dob - String

(BETA) Deprecated: Use date_of_birth instead.

firstname - String

(BETA) The customer's first name.

gender - Int

(BETA) The customer's gender (Male - 1, Female - 2).

is_subscribed - Boolean

(BETA) Indicates whether the customer is subscribed to the company's newsletter.

lastname - String

(BETA) The customer's family name.

middlename - String

(BETA) The customer's middle name.

prefix - String

(BETA) An honorific, such as Dr., Mr., or Mrs.

suffix - String

(BETA) A value such as Sr., Jr., or III.

taxvat - String

(BETA) The customer's Tax/VAT number (for corporate customers).

Example
{
  "allow_remote_shopping_assistance": true,
  "date_of_birth": "abc123",
  "dob": "abc123",
  "firstname": "abc123",
  "gender": 987,
  "is_subscribed": true,
  "lastname": "xyz789",
  "middlename": "abc123",
  "prefix": "abc123",
  "suffix": "xyz789",
  "taxvat": "abc123"
}

CustomizableAreaOption

Description

(BETA) Contains information about a text area that is defined as part of a customizable option.

Fields
Field Name Description
option_id - Int (BETA) Option ID. Use uid instead
product_sku - String (BETA) The Stock Keeping Unit of the base product.
required - Boolean (BETA) Indicates whether the option is required.
sort_order - Int (BETA) The order in which the option is displayed.
title - String (BETA) The display name for this option.
uid - ID! (BETA) The unique ID for a CustomizableOptionInterface object.
value - CustomizableAreaValue (BETA) An object that defines a text area.
Example
{
  "option_id": 987,
  "product_sku": "abc123",
  "required": true,
  "sort_order": 987,
  "title": "xyz789",
  "uid": "4",
  "value": CustomizableAreaValue
}

CustomizableAreaValue

Description

(BETA) Defines the price and sku of a product whose page contains a customized text area.

Fields
Field Name Description
max_characters - Int (BETA) The maximum number of characters that can be entered for this customizable option.
price - Float (BETA) The price assigned to this option.
price_type - PriceTypeEnum (BETA) FIXED, PERCENT, or DYNAMIC.
sku - String (BETA) The Stock Keeping Unit for this option.
uid - ID! (BETA) The unique ID for a CustomizableAreaValue object.
Example
{
  "max_characters": 987,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "xyz789",
  "uid": "4"
}

CustomizableCheckboxOption

Description

(BETA) Contains information about a set of checkbox values that are defined as part of a customizable option.

Fields
Field Name Description
option_id - Int (BETA) Option ID. Use uid instead
required - Boolean (BETA) Indicates whether the option is required.
sort_order - Int (BETA) The order in which the option is displayed.
title - String (BETA) The display name for this option.
uid - ID! (BETA) The unique ID for a CustomizableOptionInterface object.
value - [CustomizableCheckboxValue] (BETA) An array that defines a set of checkbox values.
Example
{
  "option_id": 123,
  "required": true,
  "sort_order": 123,
  "title": "abc123",
  "uid": 4,
  "value": [CustomizableCheckboxValue]
}

CustomizableCheckboxValue

Description

(BETA) Defines the price and sku of a product whose page contains a customized set of checkbox values.

Fields
Field Name Description
option_type_id - Int (BETA) The ID assigned to the value.
price - Float (BETA) The price assigned to this option.
price_type - PriceTypeEnum (BETA) FIXED, PERCENT, or DYNAMIC.
sku - String (BETA) The Stock Keeping Unit for this option.
sort_order - Int (BETA) The order in which the checkbox value is displayed.
title - String (BETA) The display name for this option.
uid - ID! (BETA) The unique ID for a CustomizableCheckboxValue object.
Example
{
  "option_type_id": 987,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "abc123",
  "sort_order": 987,
  "title": "xyz789",
  "uid": 4
}

CustomizableDateOption

Description

(BETA) Contains information about a date picker that is defined as part of a customizable option.

Fields
Field Name Description
option_id - Int (BETA) Option ID. Use uid instead
product_sku - String (BETA) The Stock Keeping Unit of the base product.
required - Boolean (BETA) Indicates whether the option is required.
sort_order - Int (BETA) The order in which the option is displayed.
title - String (BETA) The display name for this option.
uid - ID! (BETA) The unique ID for a CustomizableOptionInterface object.
value - CustomizableDateValue (BETA) An object that defines a date field in a customizable option.
Example
{
  "option_id": 987,
  "product_sku": "xyz789",
  "required": true,
  "sort_order": 987,
  "title": "xyz789",
  "uid": 4,
  "value": CustomizableDateValue
}

CustomizableDateTypeEnum

Description

(BETA) Defines the customizable date type.

Values
Enum Value Description

DATE

DATE_TIME

TIME

Example
"DATE"

CustomizableDateValue

Description

(BETA) Defines the price and sku of a product whose page contains a customized date picker.

Fields
Field Name Description
price - Float (BETA) The price assigned to this option.
price_type - PriceTypeEnum (BETA) FIXED, PERCENT, or DYNAMIC.
sku - String (BETA) The Stock Keeping Unit for this option.
type - CustomizableDateTypeEnum (BETA) DATE, DATE_TIME or TIME
uid - ID! (BETA) The unique ID for a CustomizableDateValue object.
Example
{
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "abc123",
  "type": "DATE",
  "uid": 4
}

CustomizableDropDownOption

Description

(BETA) Contains information about a drop down menu that is defined as part of a customizable option.

Fields
Field Name Description
option_id - Int (BETA) Option ID. Use uid instead
required - Boolean (BETA) Indicates whether the option is required.
sort_order - Int (BETA) The order in which the option is displayed.
title - String (BETA) The display name for this option.
uid - ID! (BETA) The unique ID for a CustomizableOptionInterface object.
value - [CustomizableDropDownValue] (BETA) An array that defines the set of options for a drop down menu.
Example
{
  "option_id": 123,
  "required": true,
  "sort_order": 987,
  "title": "abc123",
  "uid": "4",
  "value": [CustomizableDropDownValue]
}

CustomizableDropDownValue

Description

(BETA) Defines the price and sku of a product whose page contains a customized drop down menu.

Fields
Field Name Description
option_type_id - Int (BETA) The ID assigned to the value.
price - Float (BETA) The price assigned to this option.
price_type - PriceTypeEnum (BETA) FIXED, PERCENT, or DYNAMIC.
sku - String (BETA) The Stock Keeping Unit for this option.
sort_order - Int (BETA) The order in which the option is displayed.
title - String (BETA) The display name for this option.
uid - ID! (BETA) The unique ID for a CustomizableDropDownValue object.
Example
{
  "option_type_id": 123,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "abc123",
  "sort_order": 987,
  "title": "xyz789",
  "uid": 4
}

CustomizableFieldOption

Description

(BETA) Contains information about a text field that is defined as part of a customizable option.

Fields
Field Name Description
option_id - Int (BETA) Option ID. Use uid instead
product_sku - String (BETA) The Stock Keeping Unit of the base product.
required - Boolean (BETA) Indicates whether the option is required.
sort_order - Int (BETA) The order in which the option is displayed.
title - String (BETA) The display name for this option.
uid - ID! (BETA) The unique ID for a CustomizableOptionInterface object.
value - CustomizableFieldValue (BETA) An object that defines a text field.
Example
{
  "option_id": 987,
  "product_sku": "xyz789",
  "required": true,
  "sort_order": 123,
  "title": "abc123",
  "uid": 4,
  "value": CustomizableFieldValue
}

CustomizableFieldValue

Description

(BETA) Defines the price and sku of a product whose page contains a customized text field.

Fields
Field Name Description
max_characters - Int (BETA) The maximum number of characters that can be entered for this customizable option.
price - Float (BETA) The price of the custom value.
price_type - PriceTypeEnum (BETA) FIXED, PERCENT, or DYNAMIC.
sku - String (BETA) The Stock Keeping Unit for this option.
uid - ID! (BETA) The unique ID for a CustomizableFieldValue object.
Example
{
  "max_characters": 123,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "xyz789",
  "uid": 4
}

CustomizableFileOption

Description

(BETA) Contains information about a file picker that is defined as part of a customizable option.

Fields
Field Name Description
option_id - Int (BETA) Option ID. Use uid instead
product_sku - String (BETA) The Stock Keeping Unit of the base product.
required - Boolean (BETA) Indicates whether the option is required.
sort_order - Int (BETA) The order in which the option is displayed.
title - String (BETA) The display name for this option.
uid - ID! (BETA) The unique ID for a CustomizableOptionInterface object.
value - CustomizableFileValue (BETA) An object that defines a file value.
Example
{
  "option_id": 123,
  "product_sku": "xyz789",
  "required": true,
  "sort_order": 123,
  "title": "xyz789",
  "uid": 4,
  "value": CustomizableFileValue
}

CustomizableFileValue

Description

(BETA) Defines the price and sku of a product whose page contains a customized file picker.

Fields
Field Name Description
file_extension - String (BETA) The file extension to accept.
image_size_x - Int (BETA) The maximum width of an image.
image_size_y - Int (BETA) The maximum height of an image.
price - Float (BETA) The price assigned to this option.
price_type - PriceTypeEnum (BETA) FIXED, PERCENT, or DYNAMIC.
sku - String (BETA) The Stock Keeping Unit for this option.
uid - ID! (BETA) The unique ID for a CustomizableFileValue object.
Example
{
  "file_extension": "abc123",
  "image_size_x": 987,
  "image_size_y": 123,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "abc123",
  "uid": "4"
}

CustomizableMultipleOption

Description

(BETA) Contains information about a multiselect that is defined as part of a customizable option.

Fields
Field Name Description
option_id - Int (BETA) Option ID. Use uid instead
required - Boolean (BETA) Indicates whether the option is required.
sort_order - Int (BETA) The order in which the option is displayed.
title - String (BETA) The display name for this option.
uid - ID! (BETA) The unique ID for a CustomizableOptionInterface object.
value - [CustomizableMultipleValue] (BETA) An array that defines the set of options for a multiselect.
Example
{
  "option_id": 987,
  "required": false,
  "sort_order": 987,
  "title": "abc123",
  "uid": 4,
  "value": [CustomizableMultipleValue]
}

CustomizableMultipleValue

Description

(BETA) Defines the price and sku of a product whose page contains a customized multiselect.

Fields
Field Name Description
option_type_id - Int (BETA) The ID assigned to the value.
price - Float (BETA) The price assigned to this option.
price_type - PriceTypeEnum (BETA) FIXED, PERCENT, or DYNAMIC.
sku - String (BETA) The Stock Keeping Unit for this option.
sort_order - Int (BETA) The order in which the option is displayed.
title - String (BETA) The display name for this option.
uid - ID! (BETA) The unique ID for a CustomizableMultipleValue object.
Example
{
  "option_type_id": 123,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "xyz789",
  "sort_order": 123,
  "title": "xyz789",
  "uid": 4
}

CustomizableOptionInput

Description

(BETA) Defines a customizable option.

Fields
Input Field Description
id - Int

(BETA) The customizable option ID of the product.

value_string - String!

(BETA) The string value of the option.

Example
{"id": 123, "value_string": "abc123"}

CustomizableOptionInterface

Description

(BETA) Contains basic information about a customizable option. It can be implemented by several types of configurable options.

Fields
Field Name Description
option_id - Int (BETA) Option ID. Use uid instead
required - Boolean (BETA) Indicates whether the option is required.
sort_order - Int (BETA) The order in which the option is displayed.
title - String (BETA) The display name for this option.
uid - ID! (BETA) The unique ID for a CustomizableOptionInterface object.
Example
{
  "option_id": 987,
  "required": true,
  "sort_order": 987,
  "title": "abc123",
  "uid": 4
}

CustomizableProductInterface

Description

(BETA) Contains information about customizable product options.

Fields
Field Name Description
options - [CustomizableOptionInterface] (BETA) An array of options for a customizable product.
Example
{"options": [CustomizableOptionInterface]}

CustomizableRadioOption

Description

(BETA) Contains information about a set of radio buttons that are defined as part of a customizable option.

Fields
Field Name Description
option_id - Int (BETA) Option ID. Use uid instead
required - Boolean (BETA) Indicates whether the option is required.
sort_order - Int (BETA) The order in which the option is displayed.
title - String (BETA) The display name for this option.
uid - ID! (BETA) The unique ID for a CustomizableOptionInterface object.
value - [CustomizableRadioValue] (BETA) An array that defines a set of radio buttons.
Example
{
  "option_id": 987,
  "required": false,
  "sort_order": 987,
  "title": "xyz789",
  "uid": 4,
  "value": [CustomizableRadioValue]
}

CustomizableRadioValue

Description

(BETA) Defines the price and sku of a product whose page contains a customized set of radio buttons.

Fields
Field Name Description
option_type_id - Int (BETA) The ID assigned to the value.
price - Float (BETA) The price assigned to this option.
price_type - PriceTypeEnum (BETA) FIXED, PERCENT, or DYNAMIC.
sku - String (BETA) The Stock Keeping Unit for this option.
sort_order - Int (BETA) The order in which the radio button is displayed.
title - String (BETA) The display name for this option.
uid - ID! (BETA) The unique ID for a CustomizableRadioValue object.
Example
{
  "option_type_id": 987,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "abc123",
  "sort_order": 123,
  "title": "abc123",
  "uid": 4
}

DeleteCompanyRoleOutput

Description

(BETA) Contains the response to the request to delete the company role.

Fields
Field Name Description
success - Boolean! (BETA) SIndicates whether the company role has been deleted successfully.
Example
{"success": false}

DeleteCompanyTeamOutput

Description

(BETA) Contains the status of the request to delete a company team.

Fields
Field Name Description
success - Boolean! (BETA) Indicates whether the delete operation succeeded.
Example
{"success": true}

DeleteCompanyUserOutput

Description

(BETA) Contains the response to the request to delete the company user.

Fields
Field Name Description
success - Boolean! (BETA) Indicates whether the company user has been deactivated successfully.
Example
{"success": true}

DeleteCompareListOutput

Description

(BETA) Contains the results of the request to delete a compare list.

Fields
Field Name Description
result - Boolean! (BETA) Indicates whether the compare list was successfully deleted.
Example
{"result": true}

DeleteNegotiableQuoteError

Example
NegotiableQuoteInvalidStateError

DeleteNegotiableQuoteOperationFailure

Description

(BETA) Contains details about a failed delete operation on a negotiable quote.

Fields
Field Name Description
errors - [DeleteNegotiableQuoteError]!
quote_uid - ID! (BETA) The unique ID of a NegotiableQuote object.
Example
{
  "errors": [NegotiableQuoteInvalidStateError],
  "quote_uid": 4
}

DeleteNegotiableQuoteOperationResult

Example
NegotiableQuoteUidOperationSuccess

DeleteNegotiableQuotesInput

Fields
Input Field Description
quote_uids - [ID]!

(BETA) A list of unique IDs for NegotiableQuote objects to delete.

Example
{"quote_uids": [4]}

DeleteNegotiableQuotesOutput

Description

(BETA) Contains a list of undeleted negotiable quotes the company user can view.

Fields
Field Name Description
negotiable_quotes - NegotiableQuotesOutput (BETA) A list of negotiable quotes that the customer can view
Arguments
filter - NegotiableQuoteFilterInput

(BETA) The filter to use to determine which negotiable quotes to delete.

pageSize - Int

(BETA) The maximum number of results to return at once. The default value is 20.

currentPage - Int

(BETA) The page of results to return. The default value is 1.

sort - NegotiableQuoteSortInput

(BETA) The field to use for sorting results.

operation_results - [DeleteNegotiableQuoteOperationResult]! (BETA) An array of deleted negotiable quote UIDs and details about any errors.
result_status - BatchMutationStatus! (BETA) The status of the request to delete one or more negotiable quotes.
Example
{
  "negotiable_quotes": NegotiableQuotesOutput,
  "operation_results": [
    NegotiableQuoteUidOperationSuccess
  ],
  "result_status": "SUCCESS"
}

DeletePaymentTokenOutput

Description

(BETA) Indicates whether the request succeeded and returns the remaining customer payment tokens.

Fields
Field Name Description
customerPaymentTokens - CustomerPaymentTokens (BETA) A container for the customer's remaining payment tokens.
result - Boolean! (BETA) Indicates whether the request succeeded.
Example
{
  "customerPaymentTokens": CustomerPaymentTokens,
  "result": false
}

DeletePurchaseOrderApprovalRuleError

Description

(BETA) Contains details about an error that occurred when deleting an approval rule .

Fields
Field Name Description
message - String (BETA) The text of the error message.
type - DeletePurchaseOrderApprovalRuleErrorType (BETA) The error type.
Example
{"message": "abc123", "type": "UNDEFINED"}

DeletePurchaseOrderApprovalRuleErrorType

Values
Enum Value Description

UNDEFINED

NOT_FOUND

Example
"UNDEFINED"

DeletePurchaseOrderApprovalRuleInput

Description

(BETA) Specifies the IDs of the approval rules to delete.

Fields
Input Field Description
approval_rule_uids - [ID]!

(BETA) An array of purchase order approval rule IDs.

Example
{"approval_rule_uids": ["4"]}

DeletePurchaseOrderApprovalRuleOutput

Description

(BETA) Contains any errors encountered while attempting to delete approval rules.

Fields
Field Name Description
errors - [DeletePurchaseOrderApprovalRuleError]! (BETA) An array of error messages encountered while performing the operation.
Example
{"errors": [DeletePurchaseOrderApprovalRuleError]}

DeleteRequisitionListItemsOutput

Description

(BETA) Output of the request to remove items from the requisition list.

Fields
Field Name Description
requisition_list - RequisitionList (BETA) The requisition list after removing items.
Example
{"requisition_list": RequisitionList}

DeleteRequisitionListOutput

Description

(BETA) Indicates whether the request to delete the requisition list was successful.

Fields
Field Name Description
requisition_lists - RequisitionLists (BETA) The customer's requisition lists after deleting a requisition list.
status - Boolean! (BETA) Indicates whether the request to delete the requisition list was successful.
Example
{"requisition_lists": RequisitionLists, "status": false}

DeleteWishlistOutput

Description

(BETA) Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists.

Fields
Field Name Description
status - Boolean! (BETA) Indicates whether the wish list was deleted.
wishlists - [Wishlist]! (BETA) A list of undeleted wish lists.
Example
{"status": true, "wishlists": [Wishlist]}

Discount

Description

(BETA) Defines an individual discount. A discount can be applied to the cart as a whole or to an item.

Fields
Field Name Description
amount - Money! (BETA) The amount of the discount.
label - String! (BETA) A description of the discount.
Example
{
  "amount": Money,
  "label": "abc123"
}

DownloadableCartItem

Description

(BETA) An implementation for downloadable product cart items.

Fields
Field Name Description
customizable_options - [SelectedCustomizableOption]! (BETA) An array containing the customizable options the shopper selected.
errors - [CartItemError] (BETA) An array of errors encountered while loading the cart item
id - String! Use uid instead.
links - [DownloadableProductLinks] (BETA) An array containing information about the links for the downloadable product added to the cart.
prices - CartItemPrices (BETA) Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! (BETA) Details about an item in the cart.
quantity - Float! (BETA) The quantity of this item in the cart.
samples - [DownloadableProductSamples] (BETA) An array containing information about samples of the selected downloadable product.
uid - ID! (BETA) The unique ID for a CartItemInterface object.
Example
{
  "customizable_options": [SelectedCustomizableOption],
  "errors": [CartItemError],
  "id": "abc123",
  "links": [DownloadableProductLinks],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "samples": [DownloadableProductSamples],
  "uid": 4
}

DownloadableCreditMemoItem

Description

(BETA) Defines downloadable product options for CreditMemoItemInterface.

Fields
Field Name Description
discounts - [Discount] (BETA) Details about the final discount amount for the base product, including discounts on options.
downloadable_links - [DownloadableItemsLinks] (BETA) A list of downloadable links that are refunded from the downloadable product.
id - ID! (BETA) The unique ID for a CreditMemoItemInterface object.
order_item - OrderItemInterface (BETA) The order item the credit memo is applied to.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product, including selected options.
product_sku - String! (BETA) The SKU of the base product.
quantity_refunded - Float (BETA) The number of refunded items.
Example
{
  "discounts": [Discount],
  "downloadable_links": [DownloadableItemsLinks],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_refunded": 987.65
}

DownloadableFileTypeEnum

Values
Enum Value Description

FILE

sample_url serves to get the downloadable sample

URL

sample_url serves to get the downloadable sample
Example
"FILE"

DownloadableInvoiceItem

Description

(BETA) Defines downloadable product options for InvoiceItemInterface.

Fields
Field Name Description
discounts - [Discount] (BETA) Information about the final discount amount for the base product, including discounts on options.
downloadable_links - [DownloadableItemsLinks] (BETA) A list of downloadable links that are invoiced from the downloadable product.
id - ID! (BETA) The unique ID for an InvoiceItemInterface object.
order_item - OrderItemInterface (BETA) Details about an individual order item.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product including selected options.
product_sku - String! (BETA) The SKU of the base product.
quantity_invoiced - Float (BETA) The number of invoiced items.
Example
{
  "discounts": [Discount],
  "downloadable_links": [DownloadableItemsLinks],
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_invoiced": 987.65
}

DownloadableOrderItem

Description

(BETA) Defines downloadable product options for OrderItemInterface.

Fields
Field Name Description
discounts - [Discount] (BETA) The final discount information for the product.
downloadable_links - [DownloadableItemsLinks] (BETA) A list of downloadable links that are ordered from the downloadable product.
eligible_for_return - Boolean (BETA) Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption] (BETA) The entered option for the base product, such as a logo or image.
gift_message - GiftMessage (BETA) The selected gift message for the order item
gift_wrapping - GiftWrapping (BETA) The selected gift wrapping for the order item.
id - ID! (BETA) The unique ID for an OrderItemInterface object.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price of the base product, including selected options.
product_sku - String! (BETA) The SKU of the base product.
product_type - String (BETA) The type of product, such as simple, configurable, etc.
product_url_key - String (BETA) URL key of the base product.
quantity_canceled - Float (BETA) The number of canceled items.
quantity_invoiced - Float (BETA) The number of invoiced items.
quantity_ordered - Float (BETA) The number of units ordered for this item.
quantity_refunded - Float (BETA) The number of refunded items.
quantity_returned - Float (BETA) The number of returned items.
quantity_shipped - Float (BETA) The number of shipped items.
selected_options - [OrderItemOption] (BETA) The selected options for the base product, such as color or size.
status - String (BETA) The status of the order item.
Example
{
  "discounts": [Discount],
  "downloadable_links": [DownloadableItemsLinks],
  "eligible_for_return": true,
  "entered_options": [OrderItemOption],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "4",
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "product_type": "abc123",
  "product_url_key": "xyz789",
  "quantity_canceled": 123.45,
  "quantity_invoiced": 123.45,
  "quantity_ordered": 123.45,
  "quantity_refunded": 123.45,
  "quantity_returned": 123.45,
  "quantity_shipped": 987.65,
  "selected_options": [OrderItemOption],
  "status": "abc123"
}

DownloadableProduct

Description

(BETA) Defines a product that the shopper downloads.

Fields
Field Name Description
activity - String Use the custom_attributes field instead.
attribute_set_id - Int (BETA) The attribute set assigned to the product. The field should not be used on the storefront.
canonical_url - String (BETA) The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] (BETA) The categories assigned to a product.
category_gear - String Use the custom_attributes field instead.
climate - String Use the custom_attributes field instead.
collar - String Use the custom_attributes field instead.
color - Int Use the custom_attributes field instead.
country_of_manufacture - String (BETA) The product's country of origin.
created_at - String (BETA) Timestamp indicating when the product was created. The field should not be used on the storefront.
crosssell_products - [ProductInterface] (BETA) An array of cross-sell products.
description - ComplexTextValue (BETA) Detailed information about the product. The value can include simple HTML tags.
downloadable_product_links - [DownloadableProductLinks] (BETA) An array containing information about the links for this downloadable product.
downloadable_product_samples - [DownloadableProductSamples] (BETA) An array containing information about samples of this downloadable product.
eco_collection - Int Use the custom_attributes field instead.
erin_recommends - Int Use the custom_attributes field instead.
features_bags - String Use the custom_attributes field instead.
format - Int Use the custom_attributes field instead.
gender - String Use the custom_attributes field instead.
gift_message_available - String (BETA) Indicates whether a gift message is available.
id - Int (BETA) The ID number assigned to the product. Use the uid field instead.
image - ProductImage (BETA) The relative path to the main image on the product page.
is_returnable - String (BETA) Indicates whether the product can be returned.
links_purchased_separately - Int (BETA) A value of 1 indicates that each link in the array must be purchased separately.
links_title - String (BETA) The heading above the list of downloadable products.
manufacturer - Int (BETA) A number representing the product's manufacturer. Use the custom_attributes field instead.
material - String Use the custom_attributes field instead.
media_gallery - [MediaGalleryInterface] (BETA) An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] (BETA) An array of MediaGalleryEntry objects. Use media_gallery instead.
meta_description - String (BETA) A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String (BETA) A comma-separated list of keywords that are visible only to search engines.
meta_title - String (BETA) A string that is displayed in the title bar and tab of the browser and in search results lists.
name - String (BETA) The product name. Customers use this name to identify the product.
new - Int Use the custom_attributes field instead.
new_from_date - String (BETA) The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String (BETA) The end date for new product listings.
only_x_left_in_stock - Float (BETA) Product stock only x left count
options - [CustomizableOptionInterface] (BETA) An array of options for a customizable product.
options_container - String (BETA) If the product has multiple options, determines where they appear on the product page.
pattern - String Use the custom_attributes field instead.
performance_fabric - Int Use the custom_attributes field instead.
price - ProductPrices (BETA) Indicates the price of an item. Use price_range for product price information.
price_range - PriceRange! (BETA) The range of prices for the product
price_tiers - [TierPrice] (BETA) An array of TierPrice objects.
product_links - [ProductLinksInterface] (BETA) An array of ProductLinks objects.
purpose - Int Use the custom_attributes field instead.
rating_summary - Float! (BETA) The average of all the ratings given to the product.
redirect_code - Int! (BETA) Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] (BETA) An array of related products.
relative_url - String (BETA) The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! (BETA) The total count of all the reviews given to the product.
reviews - ProductReviews! (BETA) The list of products reviews.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default is 20.

currentPage - Int

(BETA) The page of results to return. The default is 1.

sale - Int Use the custom_attributes field instead.
short_description - ComplexTextValue (BETA) A short description of the product. Its use depends on the theme.
size - Int Use the custom_attributes field instead.
sku - String (BETA) A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String Use the custom_attributes field instead.
small_image - ProductImage (BETA) The relative path to the small image, which is used on catalog pages.
special_from_date - String (BETA) The beginning date that a product has a special price. The field should not be used on the storefront.
special_price - Float (BETA) The discounted price of the product.
special_to_date - String (BETA) The end date for a product with a special price.
staged - Boolean! (BETA) Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus (BETA) Stock status of the product
strap_bags - String Use the custom_attributes field instead.
style_bags - String Use the custom_attributes field instead.
style_bottom - String Use the custom_attributes field instead.
style_general - String Use the custom_attributes field instead.
swatch_image - String (BETA) The file name of a swatch image.
thumbnail - ProductImage (BETA) The relative path to the product's thumbnail image.
tier_price - Float (BETA) The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information.
tier_prices - [ProductTierPrices] (BETA) An array of ProductTierPrices objects. Use price_tiers for product tier price information.
type - UrlRewriteEntityTypeEnum (BETA) One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String (BETA) One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead.
uid - ID! (BETA) The unique ID for a ProductInterface object.
updated_at - String (BETA) Timestamp indicating when the product was updated. The field should not be used on the storefront.
upsell_products - [ProductInterface] (BETA) An array of up-sell products.
url_key - String (BETA) The part of the URL that identifies the product
url_path - String Use product's canonical_url or url rewrites instead
url_rewrites - [UrlRewrite] (BETA) URL rewrites list
url_suffix - String (BETA) The part of the product URL that is appended after the url key
websites - [Website] (BETA) An array of websites in which the product is available. The field should not be used on the storefront.
Example
{
  "activity": "abc123",
  "attribute_set_id": 987,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "category_gear": "xyz789",
  "climate": "abc123",
  "collar": "xyz789",
  "color": 987,
  "country_of_manufacture": "xyz789",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "description": ComplexTextValue,
  "downloadable_product_links": [
    DownloadableProductLinks
  ],
  "downloadable_product_samples": [
    DownloadableProductSamples
  ],
  "eco_collection": 123,
  "erin_recommends": 987,
  "features_bags": "abc123",
  "format": 987,
  "gender": "xyz789",
  "gift_message_available": "xyz789",
  "id": 123,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "links_purchased_separately": 987,
  "links_title": "abc123",
  "manufacturer": 123,
  "material": "xyz789",
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "abc123",
  "meta_title": "abc123",
  "name": "xyz789",
  "new": 123,
  "new_from_date": "xyz789",
  "new_to_date": "xyz789",
  "only_x_left_in_stock": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "xyz789",
  "pattern": "xyz789",
  "performance_fabric": 123,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 123,
  "rating_summary": 123.45,
  "redirect_code": 123,
  "related_products": [ProductInterface],
  "relative_url": "abc123",
  "review_count": 987,
  "reviews": ProductReviews,
  "sale": 987,
  "short_description": ComplexTextValue,
  "size": 987,
  "sku": "xyz789",
  "sleeve": "abc123",
  "small_image": ProductImage,
  "special_from_date": "xyz789",
  "special_price": 987.65,
  "special_to_date": "xyz789",
  "staged": false,
  "stock_status": "IN_STOCK",
  "strap_bags": "abc123",
  "style_bags": "abc123",
  "style_bottom": "abc123",
  "style_general": "xyz789",
  "swatch_image": "abc123",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "abc123",
  "uid": "4",
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website]
}

DownloadableProductCartItemInput

Description

(BETA) Defines a single downloadable product.

Fields
Input Field Description
customizable_options - [CustomizableOptionInput]

(BETA) The ID and value of the option.

data - CartItemInput!

(BETA) The quantity and SKU of the downloadable product.

downloadable_product_links - [DownloadableProductLinksInput]

(BETA) An array of objects containing the link_id of the downloadable product link.

Example
{
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput,
  "downloadable_product_links": [
    DownloadableProductLinksInput
  ]
}

DownloadableProductLinksInput

Description

(BETA) Contains the link ID for the downloadable product.

Fields
Input Field Description
link_id - Int!

(BETA) The unique ID of the downloadable product link.

Example
{"link_id": 987}

DownloadableProductSamples

Description

(BETA) Defines characteristics of a downloadable product.

Fields
Field Name Description
id - Int This information should not be exposed on frontend.
sample_file - String sample_url serves to get the downloadable sample
sample_type - DownloadableFileTypeEnum sample_url serves to get the downloadable sample
sample_url - String (BETA) The full URL to the downloadable sample.
sort_order - Int (BETA) A number indicating the sort order.
title - String (BETA) The display name of the sample.
Example
{
  "id": 123,
  "sample_file": "xyz789",
  "sample_type": "FILE",
  "sample_url": "abc123",
  "sort_order": 123,
  "title": "abc123"
}

DownloadableRequisitionListItem

Description

(BETA) Contains details about downloadable products added to a requisition list.

Fields
Field Name Description
customizable_options - [SelectedCustomizableOption]! (BETA) Selected custom options for an item in the requisition list.
links - [DownloadableProductLinks] (BETA) An array of links for downloadable products in the requisition list.
product - ProductInterface! (BETA) Details about a requisition list item.
quantity - Float! (BETA) The quantity of the product added to the requisition list.
samples - [DownloadableProductSamples] (BETA) An array of links to downloadable product samples.
uid - ID! (BETA) The unique ID of an item in a requisition list.
Example
{
  "customizable_options": [SelectedCustomizableOption],
  "links": [DownloadableProductLinks],
  "product": ProductInterface,
  "quantity": 987.65,
  "samples": [DownloadableProductSamples],
  "uid": 4
}

DownloadableWishlistItem

Description

(BETA) A downloadable product wish list item.

Fields
Field Name Description
added_at - String! (BETA) The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]! (BETA) Custom options selected for the wish list item.
description - String (BETA) The description of the item.
id - ID! (BETA) The unique ID for a WishlistItemInterface object.
links_v2 - [DownloadableProductLinks] (BETA) An array containing information about the selected links.
product - ProductInterface (BETA) Product details of the wish list item.
quantity - Float! (BETA) The quantity of this wish list item.
samples - [DownloadableProductSamples] (BETA) An array containing information about the selected samples.
Example
{
  "added_at": "abc123",
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "id": 4,
  "links_v2": [DownloadableProductLinks],
  "product": ProductInterface,
  "quantity": 123.45,
  "samples": [DownloadableProductSamples]
}

DynamicBlock

Description

(BETA) Contains a single dynamic block.

Fields
Field Name Description
content - ComplexTextValue! (BETA) The renderable HTML code of the dynamic block.
uid - ID! (BETA) The unique ID of a DynamicBlock object.
Example
{"content": ComplexTextValue, "uid": 4}

DynamicBlockLocationEnum

Description

(BETA) Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations.

Values
Enum Value Description

CONTENT

HEADER

FOOTER

LEFT

RIGHT

Example
"CONTENT"

DynamicBlockTypeEnum

Description

(BETA) Indicates the selected Dynamic Blocks Rotator inline widget.

Values
Enum Value Description

SPECIFIED

CART_PRICE_RULE_RELATED

CATALOG_PRICE_RULE_RELATED

Example
"SPECIFIED"

DynamicBlocks

Description

(BETA) Contains an array of dynamic blocks.

Fields
Field Name Description
items - [DynamicBlock]! (BETA) An array containing individual dynamic blocks.
page_info - SearchResultPageInfo (BETA) Metadata for pagination rendering.
total_count - Int! (BETA) The number of returned dynamic blocks.
Example
{
  "items": [DynamicBlock],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

DynamicBlocksFilterInput

Description

(BETA) Defines the dynamic block filter. The filter can identify the block type, location and IDs to return.

Fields
Input Field Description
dynamic_block_uids - [ID]

(BETA) An array of dynamic block UIDs to filter on.

locations - [DynamicBlockLocationEnum]

(BETA) An array indicating the locations the dynamic block can be placed.

type - DynamicBlockTypeEnum!

(BETA) A value indicating the type of dynamic block to filter on.

Example
{"dynamic_block_uids": [4], "locations": ["CONTENT"], "type": "SPECIFIED"}

EnteredCustomAttributeInput

Description

(BETA) Contains details about a custom text attribute that the buyer entered.

Fields
Input Field Description
attribute_code - String!

(BETA) A string that identifies the entered custom attribute.

value - String!

(BETA) The text or other entered value.

Example
{
  "attribute_code": "xyz789",
  "value": "abc123"
}

EnteredOptionInput

Description

(BETA) Defines a customer-entered option.

Fields
Input Field Description
uid - ID!

(BETA) The unique ID for a CustomizableOptionInterface object, such as a CustomizableFieldOption, CustomizableFileOption, or CustomizableAreaOption object.

value - String!

(BETA) Text the customer entered.

Example
{"uid": 4, "value": "xyz789"}

EntityUrl

Description

(BETA) Contains the uid, relative_url, and type attributes.

Fields
Field Name Description
canonical_url - String Use relative_url instead.
entity_uid - ID (BETA) The unique ID for a ProductInterface, CategoryInterface, CmsPage, or similar object associated with the specified URL. This could be a product, category, or CMS page UID.
id - Int (BETA) The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID. Use entity_uid instead.
redirectCode - Int (BETA) Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String (BETA) The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
type - UrlRewriteEntityTypeEnum (BETA) One of PRODUCT, CATEGORY, or CMS_PAGE.
Example
{
  "canonical_url": "abc123",
  "entity_uid": 4,
  "id": 987,
  "redirectCode": 987,
  "relative_url": "xyz789",
  "type": "CMS_PAGE"
}

ErrorInterface

Fields
Field Name Description
message - String! (BETA) The returned error message.
Example
{"message": "xyz789"}

ExchangeRate

Description

(BETA) Lists the exchange rate.

Fields
Field Name Description
currency_to - String (BETA) Specifies the store’s default currency to exchange to.
rate - Float (BETA) The exchange rate for the store’s default currency.
Example
{"currency_to": "abc123", "rate": 987.65}

FilterEqualTypeInput

Description

(BETA) Defines a filter that matches the input exactly.

Fields
Input Field Description
eq - String

(BETA) Use this attribute to exactly match the specified string. For example, to filter on a specific category ID, specify a value such as 5.

in - [String]

(BETA) Use this attribute to filter on an array of values. For example, to filter on category IDs 4, 5, and 6, specify a value of ["4", "5", "6"].

Example
{
  "eq": "abc123",
  "in": ["xyz789"]
}

FilterMatchTypeInput

Description

(BETA) Defines a filter that performs a fuzzy search.

Fields
Input Field Description
match - String

(BETA) Use this attribute to exactly match the specified string. For example, to filter on a specific SKU, specify a value such as 24-MB01.

Example
{"match": "abc123"}

FilterRangeTypeInput

Description

(BETA) Defines a filter that matches a range of values, such as prices or dates.

Fields
Input Field Description
from - String

(BETA) Use this attribute to specify the lowest possible value in the range.

to - String

(BETA) Use this attribute to specify the highest possible value in the range.

Example
{
  "from": "abc123",
  "to": "xyz789"
}

FilterStringTypeInput

Description

(BETA) Defines a filter for an input string.

Fields
Input Field Description
eq - String

(BETA) Filters items that are exactly the same as the specified string.

in - [String]

(BETA) Filters items that are exactly the same as entries specified in an array of strings.

match - String

(BETA) Defines a filter that performs a fuzzy search using the specified string.

Example
{
  "eq": "xyz789",
  "in": ["abc123"],
  "match": "abc123"
}

FilterTypeInput

Description

(BETA) Defines the comparison operators that can be used in a filter.

Fields
Input Field Description
eq - String

(BETA) Equals.

finset - [String]
from - String

(BETA) From. Must be used with the to field.

gt - String

(BETA) Greater than.

gteq - String

(BETA) Greater than or equal to.

in - [String]

(BETA) In. The value can contain a set of comma-separated values.

like - String

(BETA) Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters.

lt - String

(BETA) Less than.

lteq - String

(BETA) Less than or equal to.

moreq - String

(BETA) More than or equal to.

neq - String

(BETA) Not equal to.

nin - [String]

(BETA) Not in. The value can contain a set of comma-separated values.

notnull - String

(BETA) Not null.

null - String

(BETA) Is null.

to - String

(BETA) To. Must be used with the from field.

Example
{
  "eq": "xyz789",
  "finset": ["xyz789"],
  "from": "xyz789",
  "gt": "xyz789",
  "gteq": "abc123",
  "in": ["abc123"],
  "like": "abc123",
  "lt": "xyz789",
  "lteq": "xyz789",
  "moreq": "abc123",
  "neq": "xyz789",
  "nin": ["xyz789"],
  "notnull": "xyz789",
  "null": "xyz789",
  "to": "abc123"
}

FixedProductTax

Description

(BETA) A single FPT that can be applied to a product price.

Fields
Field Name Description
amount - Money (BETA) The amount of the Fixed Product Tax.
label - String (BETA) The display label assigned to the Fixed Product Tax.
Example
{
  "amount": Money,
  "label": "xyz789"
}

FixedProductTaxDisplaySettings

Description

(BETA) Lists display settings for the Fixed Product Tax.

Values
Enum Value Description

INCLUDE_FPT_WITHOUT_DETAILS

(BETA) The displayed price includes the FPT amount without displaying the ProductPrice.fixed_product_taxes values. This value corresponds to 'Including FPT only'.

INCLUDE_FPT_WITH_DETAILS

(BETA) The displayed price includes the FPT amount while displaying the values of ProductPrice.fixed_product_taxes separately. This value corresponds to 'Including FPT and FPT description'.

EXCLUDE_FPT_AND_INCLUDE_WITH_DETAILS

(BETA) The displayed price does not include the FPT amount. The values of ProductPrice.fixed_product_taxes and the price including the FPT are displayed separately. This value corresponds to 'Excluding FPT, Including FPT description and final price.'

EXCLUDE_FPT_WITHOUT_DETAILS

(BETA) The displayed price does not include the FPT amount. The values from ProductPrice.fixed_product_taxes are not displayed. This value corresponds to 'Excluding FPT'.

FPT_DISABLED

(BETA) The FPT feature is not enabled. You can omit ProductPrice.fixed_product_taxes from your query.
Example
"INCLUDE_FPT_WITHOUT_DETAILS"

Float

Description

(BETA) The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45

GenerateCustomerTokenAsAdminInput

Description

(BETA) Identifies which customer requires remote shopping assistance.

Fields
Input Field Description
customer_email - String!

(BETA) The email address of the customer requesting remote shopping assistance.

Example
{"customer_email": "xyz789"}

GenerateCustomerTokenAsAdminOutput

Description

(BETA) Contains the generated customer token.

Fields
Field Name Description
customer_token - String! (BETA) The generated customer token.
Example
{"customer_token": "xyz789"}

GiftCardAccount

Description

(BETA) Contains details about the gift card account.

Fields
Field Name Description
balance - Money (BETA) The balance remaining on the gift card.
code - String (BETA) The gift card account code.
expiration_date - String (BETA) The expiration date of the gift card.
Example
{
  "balance": Money,
  "code": "abc123",
  "expiration_date": "abc123"
}

GiftCardAccountInput

Description

(BETA) Contains the gift card code.

Fields
Input Field Description
gift_card_code - String!

(BETA) The applied gift card code.

Example
{"gift_card_code": "abc123"}

GiftCardAmounts

Description

(BETA) Contains the value of a gift card, the website that generated the card, and related information.

Fields
Field Name Description
attribute_id - Int (BETA) An internal attribute ID.
uid - ID! (BETA) The unique ID for a GiftCardAmounts object.
value - Float (BETA) The value of the gift card.
value_id - Int (BETA) An ID that is assigned to each unique gift card amount. Use uid instead
website_id - Int (BETA) The ID of the website that generated the gift card.
website_value - Float (BETA) The value of the gift card.
Example
{
  "attribute_id": 987,
  "uid": "4",
  "value": 123.45,
  "value_id": 987,
  "website_id": 123,
  "website_value": 987.65
}

GiftCardCartItem

Description

(BETA) Contains details about a gift card that has been added to a cart.

Fields
Field Name Description
amount - Money! (BETA) The amount and currency of the gift card.
customizable_options - [SelectedCustomizableOption]! (BETA) An array of customizations applied to the gift card.
errors - [CartItemError] (BETA) An array of errors encountered while loading the cart item
id - String! Use uid instead.
message - String (BETA) The message from the sender to the recipient.
prices - CartItemPrices (BETA) Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! (BETA) Details about an item in the cart.
quantity - Float! (BETA) The quantity of this item in the cart.
recipient_email - String (BETA) The email address of the person receiving the gift card.
recipient_name - String! (BETA) The name of the person receiving the gift card.
sender_email - String (BETA) The email address of the sender.
sender_name - String! (BETA) The name of the sender.
uid - ID! (BETA) The unique ID for a CartItemInterface object.
Example
{
  "amount": Money,
  "customizable_options": [SelectedCustomizableOption],
  "errors": [CartItemError],
  "id": "abc123",
  "message": "abc123",
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "recipient_email": "abc123",
  "recipient_name": "abc123",
  "sender_email": "xyz789",
  "sender_name": "abc123",
  "uid": 4
}

GiftCardCreditMemoItem

Fields
Field Name Description
discounts - [Discount] (BETA) Details about the final discount amount for the base product, including discounts on options.
gift_card - GiftCardItem (BETA) Selected gift card properties for a credit memo item.
id - ID! (BETA) The unique ID for a CreditMemoItemInterface object.
order_item - OrderItemInterface (BETA) The order item the credit memo is applied to.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product, including selected options.
product_sku - String! (BETA) The SKU of the base product.
quantity_refunded - Float (BETA) The number of refunded items.
Example
{
  "discounts": [Discount],
  "gift_card": GiftCardItem,
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_refunded": 987.65
}

GiftCardInvoiceItem

Fields
Field Name Description
discounts - [Discount] (BETA) Information about the final discount amount for the base product, including discounts on options.
gift_card - GiftCardItem (BETA) Selected gift card properties for an invoice item.
id - ID! (BETA) The unique ID for an InvoiceItemInterface object.
order_item - OrderItemInterface (BETA) Details about an individual order item.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product including selected options.
product_sku - String! (BETA) The SKU of the base product.
quantity_invoiced - Float (BETA) The number of invoiced items.
Example
{
  "discounts": [Discount],
  "gift_card": GiftCardItem,
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_invoiced": 123.45
}

GiftCardItem

Description

(BETA) Contains details about a gift card.

Fields
Field Name Description
message - String (BETA) The message from the sender to the recipient.
recipient_email - String (BETA) The email address of the receiver of a virtual gift card.
recipient_name - String (BETA) The name of the receiver of a physical or virtual gift card.
sender_email - String (BETA) The email address of the sender of a virtual gift card.
sender_name - String (BETA) The name of the sender of a physical or virtual gift card.
Example
{
  "message": "xyz789",
  "recipient_email": "abc123",
  "recipient_name": "abc123",
  "sender_email": "xyz789",
  "sender_name": "abc123"
}

GiftCardOptions

Description

(BETA) Contains details about the sender, recipient, and amount of a gift card.

Fields
Field Name Description
amount - Money (BETA) The amount and currency of the gift card.
custom_giftcard_amount - Money (BETA) The custom amount and currency of the gift card.
message - String (BETA) A message to the recipient.
recipient_email - String (BETA) The email address of the person receiving the gift card.
recipient_name - String (BETA) The name of the person receiving the gift card.
sender_email - String (BETA) The email address of the person sending the gift card.
sender_name - String (BETA) The name of the person sending the gift card.
Example
{
  "amount": Money,
  "custom_giftcard_amount": Money,
  "message": "abc123",
  "recipient_email": "xyz789",
  "recipient_name": "xyz789",
  "sender_email": "xyz789",
  "sender_name": "xyz789"
}

GiftCardOrderItem

Fields
Field Name Description
discounts - [Discount] (BETA) The final discount information for the product.
eligible_for_return - Boolean (BETA) Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption] (BETA) The entered option for the base product, such as a logo or image.
gift_card - GiftCardItem (BETA) Selected gift card properties for an order item.
gift_message - GiftMessage (BETA) The selected gift message for the order item
gift_wrapping - GiftWrapping (BETA) The selected gift wrapping for the order item.
id - ID! (BETA) The unique ID for an OrderItemInterface object.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price of the base product, including selected options.
product_sku - String! (BETA) The SKU of the base product.
product_type - String (BETA) The type of product, such as simple, configurable, etc.
product_url_key - String (BETA) URL key of the base product.
quantity_canceled - Float (BETA) The number of canceled items.
quantity_invoiced - Float (BETA) The number of invoiced items.
quantity_ordered - Float (BETA) The number of units ordered for this item.
quantity_refunded - Float (BETA) The number of refunded items.
quantity_returned - Float (BETA) The number of returned items.
quantity_shipped - Float (BETA) The number of shipped items.
selected_options - [OrderItemOption] (BETA) The selected options for the base product, such as color or size.
status - String (BETA) The status of the order item.
Example
{
  "discounts": [Discount],
  "eligible_for_return": false,
  "entered_options": [OrderItemOption],
  "gift_card": GiftCardItem,
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": 4,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "product_type": "xyz789",
  "product_url_key": "xyz789",
  "quantity_canceled": 987.65,
  "quantity_invoiced": 123.45,
  "quantity_ordered": 123.45,
  "quantity_refunded": 123.45,
  "quantity_returned": 987.65,
  "quantity_shipped": 123.45,
  "selected_options": [OrderItemOption],
  "status": "xyz789"
}

GiftCardProduct

Description

(BETA) Defines properties of a gift card.

Fields
Field Name Description
activity - String Use the custom_attributes field instead.
allow_message - Boolean (BETA) Indicates whether the customer can provide a message to accompany the gift card.
allow_open_amount - Boolean (BETA) Indicates whether shoppers have the ability to set the value of the gift card.
attribute_set_id - Int (BETA) The attribute set assigned to the product. The field should not be used on the storefront.
canonical_url - String (BETA) The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] (BETA) The categories assigned to a product.
category_gear - String Use the custom_attributes field instead.
climate - String Use the custom_attributes field instead.
collar - String Use the custom_attributes field instead.
color - Int Use the custom_attributes field instead.
country_of_manufacture - String (BETA) The product's country of origin.
created_at - String (BETA) Timestamp indicating when the product was created. The field should not be used on the storefront.
crosssell_products - [ProductInterface] (BETA) An array of cross-sell products.
description - ComplexTextValue (BETA) Detailed information about the product. The value can include simple HTML tags.
eco_collection - Int Use the custom_attributes field instead.
erin_recommends - Int Use the custom_attributes field instead.
features_bags - String Use the custom_attributes field instead.
format - Int Use the custom_attributes field instead.
gender - String Use the custom_attributes field instead.
gift_card_options - [CustomizableOptionInterface]! (BETA) An array of customizable gift card options.
gift_message_available - String (BETA) Indicates whether a gift message is available.
giftcard_amounts - [GiftCardAmounts] (BETA) An array that contains information about the values and ID of a gift card.
giftcard_type - GiftCardTypeEnum (BETA) An enumeration that specifies the type of gift card.
id - Int (BETA) The ID number assigned to the product. Use the uid field instead.
image - ProductImage (BETA) The relative path to the main image on the product page.
is_redeemable - Boolean (BETA) Indicates whether the customer can redeem the value on the card for cash.
is_returnable - String (BETA) Indicates whether the product can be returned.
lifetime - Int (BETA) The number of days after purchase until the gift card expires. A null value means there is no limit.
manufacturer - Int (BETA) A number representing the product's manufacturer. Use the custom_attributes field instead.
material - String Use the custom_attributes field instead.
media_gallery - [MediaGalleryInterface] (BETA) An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] (BETA) An array of MediaGalleryEntry objects. Use media_gallery instead.
message_max_length - Int (BETA) The maximum number of characters the gift message can contain.
meta_description - String (BETA) A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String (BETA) A comma-separated list of keywords that are visible only to search engines.
meta_title - String (BETA) A string that is displayed in the title bar and tab of the browser and in search results lists.
name - String (BETA) The product name. Customers use this name to identify the product.
new - Int Use the custom_attributes field instead.
new_from_date - String (BETA) The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String (BETA) The end date for new product listings.
only_x_left_in_stock - Float (BETA) Product stock only x left count
open_amount_max - Float (BETA) The maximum acceptable value of an open amount gift card.
open_amount_min - Float (BETA) The minimum acceptable value of an open amount gift card.
options - [CustomizableOptionInterface] (BETA) An array of options for a customizable product.
options_container - String (BETA) If the product has multiple options, determines where they appear on the product page.
pattern - String Use the custom_attributes field instead.
performance_fabric - Int Use the custom_attributes field instead.
price - ProductPrices (BETA) Indicates the price of an item. Use price_range for product price information.
price_range - PriceRange! (BETA) The range of prices for the product
price_tiers - [TierPrice] (BETA) An array of TierPrice objects.
product_links - [ProductLinksInterface] (BETA) An array of ProductLinks objects.
purpose - Int Use the custom_attributes field instead.
rating_summary - Float! (BETA) The average of all the ratings given to the product.
redirect_code - Int! (BETA) Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] (BETA) An array of related products.
relative_url - String (BETA) The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! (BETA) The total count of all the reviews given to the product.
reviews - ProductReviews! (BETA) The list of products reviews.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default is 20.

currentPage - Int

(BETA) The page of results to return. The default is 1.

sale - Int Use the custom_attributes field instead.
short_description - ComplexTextValue (BETA) A short description of the product. Its use depends on the theme.
size - Int Use the custom_attributes field instead.
sku - String (BETA) A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String Use the custom_attributes field instead.
small_image - ProductImage (BETA) The relative path to the small image, which is used on catalog pages.
special_from_date - String (BETA) The beginning date that a product has a special price. The field should not be used on the storefront.
special_price - Float (BETA) The discounted price of the product.
special_to_date - String (BETA) The end date for a product with a special price.
staged - Boolean! (BETA) Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus (BETA) Stock status of the product
strap_bags - String Use the custom_attributes field instead.
style_bags - String Use the custom_attributes field instead.
style_bottom - String Use the custom_attributes field instead.
style_general - String Use the custom_attributes field instead.
swatch_image - String (BETA) The file name of a swatch image.
thumbnail - ProductImage (BETA) The relative path to the product's thumbnail image.
tier_price - Float (BETA) The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information.
tier_prices - [ProductTierPrices] (BETA) An array of ProductTierPrices objects. Use price_tiers for product tier price information.
type - UrlRewriteEntityTypeEnum (BETA) One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String (BETA) One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead.
uid - ID! (BETA) The unique ID for a ProductInterface object.
updated_at - String (BETA) Timestamp indicating when the product was updated. The field should not be used on the storefront.
upsell_products - [ProductInterface] (BETA) An array of up-sell products.
url_key - String (BETA) The part of the URL that identifies the product
url_path - String Use product's canonical_url or url rewrites instead
url_rewrites - [UrlRewrite] (BETA) URL rewrites list
url_suffix - String (BETA) The part of the product URL that is appended after the url key
websites - [Website] (BETA) An array of websites in which the product is available. The field should not be used on the storefront.
weight - Float (BETA) The weight of the item, in units defined by the store.
Example
{
  "activity": "abc123",
  "allow_message": true,
  "allow_open_amount": true,
  "attribute_set_id": 123,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "category_gear": "abc123",
  "climate": "xyz789",
  "collar": "abc123",
  "color": 987,
  "country_of_manufacture": "xyz789",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "description": ComplexTextValue,
  "eco_collection": 123,
  "erin_recommends": 123,
  "features_bags": "abc123",
  "format": 123,
  "gender": "xyz789",
  "gift_card_options": [CustomizableOptionInterface],
  "gift_message_available": "xyz789",
  "giftcard_amounts": [GiftCardAmounts],
  "giftcard_type": "VIRTUAL",
  "id": 987,
  "image": ProductImage,
  "is_redeemable": true,
  "is_returnable": "abc123",
  "lifetime": 987,
  "manufacturer": 987,
  "material": "xyz789",
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "message_max_length": 987,
  "meta_description": "xyz789",
  "meta_keyword": "abc123",
  "meta_title": "abc123",
  "name": "abc123",
  "new": 123,
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 987.65,
  "open_amount_max": 987.65,
  "open_amount_min": 987.65,
  "options": [CustomizableOptionInterface],
  "options_container": "xyz789",
  "pattern": "xyz789",
  "performance_fabric": 123,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 123,
  "rating_summary": 123.45,
  "redirect_code": 123,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 987,
  "reviews": ProductReviews,
  "sale": 987,
  "short_description": ComplexTextValue,
  "size": 123,
  "sku": "abc123",
  "sleeve": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "abc123",
  "staged": true,
  "stock_status": "IN_STOCK",
  "strap_bags": "abc123",
  "style_bags": "xyz789",
  "style_bottom": "abc123",
  "style_general": "xyz789",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 123.45,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "xyz789",
  "uid": 4,
  "updated_at": "abc123",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website],
  "weight": 987.65
}

GiftCardRequisitionListItem

Description

(BETA) Contains details about gift cards added to a requisition list.

Fields
Field Name Description
customizable_options - [SelectedCustomizableOption]! (BETA) Selected custom options for an item in the requisition list.
gift_card_options - GiftCardOptions! (BETA) An array that defines gift card properties.
product - ProductInterface! (BETA) Details about a requisition list item.
quantity - Float! (BETA) The amount added.
uid - ID! (BETA) The unique ID for the requisition list item.
Example
{
  "customizable_options": [SelectedCustomizableOption],
  "gift_card_options": GiftCardOptions,
  "product": ProductInterface,
  "quantity": 987.65,
  "uid": "4"
}

GiftCardShipmentItem

Fields
Field Name Description
gift_card - GiftCardItem (BETA) Selected gift card properties for a shipment item.
id - ID! (BETA) The unique ID for a ShipmentItemInterface object.
order_item - OrderItemInterface (BETA) The order item associated with the shipment item.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product.
product_sku - String! (BETA) The SKU of the base product.
quantity_shipped - Float! (BETA) The number of shipped items.
Example
{
  "gift_card": GiftCardItem,
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_shipped": 987.65
}

GiftCardTypeEnum

Description

(BETA) Specifies the gift card type.

Values
Enum Value Description

VIRTUAL

PHYSICAL

COMBINED

Example
"VIRTUAL"

GiftCardWishlistItem

Description

(BETA) A single gift card added to a wish list.

Fields
Field Name Description
added_at - String! (BETA) The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]! (BETA) Custom options selected for the wish list item.
description - String (BETA) The description of the item.
gift_card_options - GiftCardOptions! (BETA) Details about a gift card.
id - ID! (BETA) The unique ID for a WishlistItemInterface object.
product - ProductInterface (BETA) Product details of the wish list item.
quantity - Float! (BETA) The quantity of this wish list item.
Example
{
  "added_at": "xyz789",
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "gift_card_options": GiftCardOptions,
  "id": "4",
  "product": ProductInterface,
  "quantity": 987.65
}

GiftMessage

Description

(BETA) Contains the text of a gift message, its sender, and recipient

Fields
Field Name Description
from - String! (BETA) Sender name
message - String! (BETA) Gift message text
to - String! (BETA) Recipient name
Example
{
  "from": "xyz789",
  "message": "xyz789",
  "to": "xyz789"
}

GiftMessageInput

Description

(BETA) Defines a gift message.

Fields
Input Field Description
from - String!

(BETA) The name of the sender.

message - String!

(BETA) The text of the gift message.

to - String!

(BETA) The name of the recepient.

Example
{
  "from": "xyz789",
  "message": "abc123",
  "to": "xyz789"
}

GiftOptionsPrices

Description

(BETA) Contains prices for gift wrapping options.

Fields
Field Name Description
gift_wrapping_for_items - Money (BETA) Price of the gift wrapping for all individual order items.
gift_wrapping_for_order - Money (BETA) Price of the gift wrapping for the whole order.
printed_card - Money (BETA) Price for the printed card.
Example
{
  "gift_wrapping_for_items": Money,
  "gift_wrapping_for_order": Money,
  "printed_card": Money
}

GiftRegistry

Description

(BETA) Contains details about a gift registry.

Fields
Field Name Description
created_at - String! (BETA) The date on which the gift registry was created. Only the registry owner can access this attribute.
dynamic_attributes - [GiftRegistryDynamicAttribute] (BETA) An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair.
event_name - String! (BETA) The name of the event.
items - [GiftRegistryItemInterface] (BETA) An array of products added to the gift registry.
message - String! (BETA) The message text the customer entered to describe the event.
owner_name - String! (BETA) The customer who created the gift registry.
privacy_settings - GiftRegistryPrivacySettings! (BETA) An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute.
registrants - [GiftRegistryRegistrant] (BETA) Contains details about each registrant for the event.
shipping_address - CustomerAddress (BETA) Contains the customer's shipping address. Only the registry owner can access this attribute.
status - GiftRegistryStatus! (BETA) An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute.
type - GiftRegistryType (BETA) The type of gift registry.
uid - ID! (BETA) The unique ID assigned to the gift registry.
Example
{
  "created_at": "xyz789",
  "dynamic_attributes": [GiftRegistryDynamicAttribute],
  "event_name": "abc123",
  "items": [GiftRegistryItemInterface],
  "message": "xyz789",
  "owner_name": "xyz789",
  "privacy_settings": "PRIVATE",
  "registrants": [GiftRegistryRegistrant],
  "shipping_address": CustomerAddress,
  "status": "ACTIVE",
  "type": GiftRegistryType,
  "uid": 4
}

GiftRegistryDynamicAttribute

Fields
Field Name Description
code - ID! (BETA) The internal ID of the dynamic attribute.
group - GiftRegistryDynamicAttributeGroup! (BETA) Indicates which group the dynamic attribute is a member of.
label - String! (BETA) The display name of the dynamic attribute.
value - String! (BETA) A corresponding value for the code.
Example
{
  "code": "4",
  "group": "EVENT_INFORMATION",
  "label": "xyz789",
  "value": "abc123"
}

GiftRegistryDynamicAttributeGroup

Description

(BETA) Defines the group type of a gift registry dynamic attribute.

Values
Enum Value Description

EVENT_INFORMATION

PRIVACY_SETTINGS

REGISTRANT

GENERAL_INFORMATION

DETAILED_INFORMATION

SHIPPING_ADDRESS

Example
"EVENT_INFORMATION"

GiftRegistryDynamicAttributeInput

Description

(BETA) Defines a dynamic attribute.

Fields
Input Field Description
code - ID!

(BETA) A unique key for an additional attribute of the event.

value - String!

(BETA) A string that describes a dynamic attribute.

Example
{"code": 4, "value": "abc123"}

GiftRegistryDynamicAttributeInterface

Fields
Field Name Description
code - ID! (BETA) The internal ID of the dynamic attribute.
label - String! (BETA) The display name of the dynamic attribute.
value - String! (BETA) A corresponding value for the code.
Possible Types
GiftRegistryDynamicAttributeInterface Types

GiftRegistryRegistrantDynamicAttribute

GiftRegistryDynamicAttribute

Example
{
  "code": 4,
  "label": "abc123",
  "value": "xyz789"
}

GiftRegistryDynamicAttributeMetadata

Fields
Field Name Description
attribute_group - String! (BETA) Indicates which group the dynamic attribute a member of.
code - ID! (BETA) The internal ID of the dynamic attribute.
input_type - String! (BETA) The selected input type for this dynamic attribute. The value can be one of several static or custom types.
is_required - Boolean! (BETA) Indicates whether the dynamic attribute is required.
label - String! (BETA) The display name of the dynamic attribute.
sort_order - Int (BETA) The order in which to display the dynamic attribute.
Example
{
  "attribute_group": "xyz789",
  "code": 4,
  "input_type": "xyz789",
  "is_required": true,
  "label": "xyz789",
  "sort_order": 987
}

GiftRegistryDynamicAttributeMetadataInterface

Fields
Field Name Description
attribute_group - String! (BETA) Indicates which group the dynamic attribute a member of.
code - ID! (BETA) The internal ID of the dynamic attribute.
input_type - String! (BETA) The selected input type for this dynamic attribute. The value can be one of several static or custom types.
is_required - Boolean! (BETA) Indicates whether the dynamic attribute is required.
label - String! (BETA) The display name of the dynamic attribute.
sort_order - Int (BETA) The order in which to display the dynamic attribute.
Possible Types
GiftRegistryDynamicAttributeMetadataInterface Types

GiftRegistryDynamicAttributeMetadata

Example
{
  "attribute_group": "xyz789",
  "code": 4,
  "input_type": "xyz789",
  "is_required": true,
  "label": "abc123",
  "sort_order": 987
}

GiftRegistryItem

Fields
Field Name Description
created_at - String! (BETA) The date the product was added to the gift registry.
note - String (BETA) A brief message about the gift registry item.
product - ProductInterface (BETA) Details about the gift registry item.
quantity - Float! (BETA) The requested quantity of the product.
quantity_fulfilled - Float! (BETA) The fulfilled quantity of the product.
uid - ID! (BETA) The unique ID of a gift registry item.
Example
{
  "created_at": "abc123",
  "note": "abc123",
  "product": ProductInterface,
  "quantity": 123.45,
  "quantity_fulfilled": 123.45,
  "uid": 4
}

GiftRegistryItemInterface

Fields
Field Name Description
created_at - String! (BETA) The date the product was added to the gift registry.
note - String (BETA) A brief message about the gift registry item.
product - ProductInterface (BETA) Details about the gift registry item.
quantity - Float! (BETA) The requested quantity of the product.
quantity_fulfilled - Float! (BETA) The fulfilled quantity of the product.
uid - ID! (BETA) The unique ID of a gift registry item.
Possible Types
GiftRegistryItemInterface Types

GiftRegistryItem

Example
{
  "created_at": "abc123",
  "note": "abc123",
  "product": ProductInterface,
  "quantity": 987.65,
  "quantity_fulfilled": 987.65,
  "uid": 4
}

GiftRegistryItemUserErrorInterface

Description

(BETA) Contains the status and any errors that encountered with the customer's gift register item.

Fields
Field Name Description
status - Boolean! (BETA) Indicates whether the attempt to move the cart items to the gift registry was successful.
user_errors - [GiftRegistryItemsUserError]! (BETA) An array of errors encountered while moving items from the cart to the gift registry.
Possible Types
GiftRegistryItemUserErrorInterface Types

MoveCartItemsToGiftRegistryOutput

Example
{
  "status": false,
  "user_errors": [GiftRegistryItemsUserError]
}

GiftRegistryItemsUserError

Description

(BETA) Contains details about an error that occurred when processing a gift registry item.

Fields
Field Name Description
code - GiftRegistryItemsUserErrorType! (BETA) An error code that describes the error encountered.
gift_registry_item_uid - ID (BETA) The unique ID of the gift registry item containing an error.
gift_registry_uid - ID (BETA) The unique ID of the GiftRegistry object containing an error.
message - String! (BETA) A localized error message.
product_uid - ID (BETA) The unique ID of the product containing an error.
Example
{
  "code": "OUT_OF_STOCK",
  "gift_registry_item_uid": "4",
  "gift_registry_uid": 4,
  "message": "xyz789",
  "product_uid": 4
}

GiftRegistryItemsUserErrorType

Description

(BETA) Defines the error type.

Values
Enum Value Description

OUT_OF_STOCK

(BETA) Used for handling out of stock products.

NOT_FOUND

(BETA) Used for exceptions like EntityNotFound.

UNDEFINED

(BETA) Used for other exceptions, such as database connection failures.
Example
"OUT_OF_STOCK"

GiftRegistryOutputInterface

Description

(BETA) Contains the customer's gift registry.

Fields
Field Name Description
gift_registry - GiftRegistry (BETA) The gift registry.
Possible Types
GiftRegistryOutputInterface Types

MoveCartItemsToGiftRegistryOutput

Example
{"gift_registry": GiftRegistry}

GiftRegistryPrivacySettings

Description

(BETA) Defines the privacy setting of the gift registry.

Values
Enum Value Description

PRIVATE

PUBLIC

Example
"PRIVATE"

GiftRegistryRegistrant

Description

(BETA) Contains details about a registrant.

Fields
Field Name Description
dynamic_attributes - [GiftRegistryRegistrantDynamicAttribute] (BETA) An array of dynamic attributes assigned to the registrant.
email - String! (BETA) The email address of the registrant. Only the registry owner can access this attribute.
firstname - String! (BETA) The first name of the registrant.
lastname - String! (BETA) The last name of the registrant.
uid - ID! (BETA) The unique ID assigned to the registrant.
Example
{
  "dynamic_attributes": [
    GiftRegistryRegistrantDynamicAttribute
  ],
  "email": "xyz789",
  "firstname": "xyz789",
  "lastname": "abc123",
  "uid": "4"
}

GiftRegistryRegistrantDynamicAttribute

Fields
Field Name Description
code - ID! (BETA) The internal ID of the dynamic attribute.
label - String! (BETA) The display name of the dynamic attribute.
value - String! (BETA) A corresponding value for the code.
Example
{
  "code": 4,
  "label": "xyz789",
  "value": "xyz789"
}

GiftRegistrySearchResult

Description

(BETA) Contains the results of a gift registry search.

Fields
Field Name Description
event_date - String (BETA) The date of the event.
event_title - String! (BETA) The title given to the event.
gift_registry_uid - ID! (BETA) The URL key of the gift registry.
location - String (BETA) The location of the event.
name - String! (BETA) The name of the gift registry owner.
type - String (BETA) The type of event being held.
Example
{
  "event_date": "abc123",
  "event_title": "abc123",
  "gift_registry_uid": 4,
  "location": "abc123",
  "name": "abc123",
  "type": "xyz789"
}

GiftRegistryShippingAddressInput

Description

(BETA) Defines a shipping address for a gift registry. Specify either address_data or the address_id. If both are provided, validation will fail.

Fields
Input Field Description
address_data - CustomerAddressInput

(BETA) Defines the shipping address for this gift registry.

address_id - ID

(BETA) The ID assigned to this customer address.

Example
{
  "address_data": CustomerAddressInput,
  "address_id": "4"
}

GiftRegistryStatus

Description

(BETA) Defines the status of the gift registry.

Values
Enum Value Description

ACTIVE

INACTIVE

Example
"ACTIVE"

GiftRegistryType

Description

(BETA) Contains details about a gift registry type.

Fields
Field Name Description
dynamic_attributes_metadata - [GiftRegistryDynamicAttributeMetadataInterface] (BETA) An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair.
label - String! (BETA) The label assigned to the gift registry type on the Admin.
uid - ID! (BETA) The unique ID assigned to the gift registry type.
Example
{
  "dynamic_attributes_metadata": [
    GiftRegistryDynamicAttributeMetadataInterface
  ],
  "label": "abc123",
  "uid": "4"
}

GiftWrapping

Description

(BETA) Contains details about the selected or available gift wrapping options.

Fields
Field Name Description
design - String! (BETA) The name of the gift wrapping design.
id - ID! (BETA) The unique ID for a GiftWrapping object. Use uid instead
image - GiftWrappingImage (BETA) The preview image for a gift wrapping option.
price - Money! (BETA) The gift wrapping price.
uid - ID! (BETA) The unique ID for a GiftWrapping object.
Example
{
  "design": "xyz789",
  "id": "4",
  "image": GiftWrappingImage,
  "price": Money,
  "uid": "4"
}

GiftWrappingImage

Description

(BETA) Points to an image associated with a gift wrapping option.

Fields
Field Name Description
label - String! (BETA) The gift wrapping preview image label.
url - String! (BETA) The gift wrapping preview image URL.
Example
{
  "label": "xyz789",
  "url": "xyz789"
}

GroupedProduct

Description

(BETA) Defines a grouped product, which consists of simple standalone products that are presented as a group.

Fields
Field Name Description
activity - String Use the custom_attributes field instead.
attribute_set_id - Int (BETA) The attribute set assigned to the product. The field should not be used on the storefront.
canonical_url - String (BETA) The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] (BETA) The categories assigned to a product.
category_gear - String Use the custom_attributes field instead.
climate - String Use the custom_attributes field instead.
collar - String Use the custom_attributes field instead.
color - Int Use the custom_attributes field instead.
country_of_manufacture - String (BETA) The product's country of origin.
created_at - String (BETA) Timestamp indicating when the product was created. The field should not be used on the storefront.
crosssell_products - [ProductInterface] (BETA) An array of cross-sell products.
description - ComplexTextValue (BETA) Detailed information about the product. The value can include simple HTML tags.
eco_collection - Int Use the custom_attributes field instead.
erin_recommends - Int Use the custom_attributes field instead.
features_bags - String Use the custom_attributes field instead.
format - Int Use the custom_attributes field instead.
gender - String Use the custom_attributes field instead.
gift_message_available - String (BETA) Indicates whether a gift message is available.
id - Int (BETA) The ID number assigned to the product. Use the uid field instead.
image - ProductImage (BETA) The relative path to the main image on the product page.
is_returnable - String (BETA) Indicates whether the product can be returned.
items - [GroupedProductItem] (BETA) An array containing grouped product items.
manufacturer - Int (BETA) A number representing the product's manufacturer. Use the custom_attributes field instead.
material - String Use the custom_attributes field instead.
media_gallery - [MediaGalleryInterface] (BETA) An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] (BETA) An array of MediaGalleryEntry objects. Use media_gallery instead.
meta_description - String (BETA) A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String (BETA) A comma-separated list of keywords that are visible only to search engines.
meta_title - String (BETA) A string that is displayed in the title bar and tab of the browser and in search results lists.
name - String (BETA) The product name. Customers use this name to identify the product.
new - Int Use the custom_attributes field instead.
new_from_date - String (BETA) The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String (BETA) The end date for new product listings.
only_x_left_in_stock - Float (BETA) Product stock only x left count
options_container - String (BETA) If the product has multiple options, determines where they appear on the product page.
pattern - String Use the custom_attributes field instead.
performance_fabric - Int Use the custom_attributes field instead.
price - ProductPrices (BETA) Indicates the price of an item. Use price_range for product price information.
price_range - PriceRange! (BETA) The range of prices for the product
price_tiers - [TierPrice] (BETA) An array of TierPrice objects.
product_links - [ProductLinksInterface] (BETA) An array of ProductLinks objects.
purpose - Int Use the custom_attributes field instead.
rating_summary - Float! (BETA) The average of all the ratings given to the product.
redirect_code - Int! (BETA) Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] (BETA) An array of related products.
relative_url - String (BETA) The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! (BETA) The total count of all the reviews given to the product.
reviews - ProductReviews! (BETA) The list of products reviews.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default is 20.

currentPage - Int

(BETA) The page of results to return. The default is 1.

sale - Int Use the custom_attributes field instead.
short_description - ComplexTextValue (BETA) A short description of the product. Its use depends on the theme.
size - Int Use the custom_attributes field instead.
sku - String (BETA) A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String Use the custom_attributes field instead.
small_image - ProductImage (BETA) The relative path to the small image, which is used on catalog pages.
special_from_date - String (BETA) The beginning date that a product has a special price. The field should not be used on the storefront.
special_price - Float (BETA) The discounted price of the product.
special_to_date - String (BETA) The end date for a product with a special price.
staged - Boolean! (BETA) Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus (BETA) Stock status of the product
strap_bags - String Use the custom_attributes field instead.
style_bags - String Use the custom_attributes field instead.
style_bottom - String Use the custom_attributes field instead.
style_general - String Use the custom_attributes field instead.
swatch_image - String (BETA) The file name of a swatch image.
thumbnail - ProductImage (BETA) The relative path to the product's thumbnail image.
tier_price - Float (BETA) The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information.
tier_prices - [ProductTierPrices] (BETA) An array of ProductTierPrices objects. Use price_tiers for product tier price information.
type - UrlRewriteEntityTypeEnum (BETA) One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String (BETA) One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead.
uid - ID! (BETA) The unique ID for a ProductInterface object.
updated_at - String (BETA) Timestamp indicating when the product was updated. The field should not be used on the storefront.
upsell_products - [ProductInterface] (BETA) An array of up-sell products.
url_key - String (BETA) The part of the URL that identifies the product
url_path - String Use product's canonical_url or url rewrites instead
url_rewrites - [UrlRewrite] (BETA) URL rewrites list
url_suffix - String (BETA) The part of the product URL that is appended after the url key
websites - [Website] (BETA) An array of websites in which the product is available. The field should not be used on the storefront.
weight - Float (BETA) The weight of the item, in units defined by the store.
Example
{
  "activity": "xyz789",
  "attribute_set_id": 987,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "category_gear": "xyz789",
  "climate": "abc123",
  "collar": "abc123",
  "color": 987,
  "country_of_manufacture": "xyz789",
  "created_at": "abc123",
  "crosssell_products": [ProductInterface],
  "description": ComplexTextValue,
  "eco_collection": 987,
  "erin_recommends": 987,
  "features_bags": "abc123",
  "format": 123,
  "gender": "xyz789",
  "gift_message_available": "abc123",
  "id": 123,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "items": [GroupedProductItem],
  "manufacturer": 123,
  "material": "xyz789",
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "abc123",
  "meta_keyword": "abc123",
  "meta_title": "abc123",
  "name": "abc123",
  "new": 987,
  "new_from_date": "xyz789",
  "new_to_date": "xyz789",
  "only_x_left_in_stock": 123.45,
  "options_container": "abc123",
  "pattern": "xyz789",
  "performance_fabric": 123,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 123,
  "rating_summary": 987.65,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 987,
  "reviews": ProductReviews,
  "sale": 987,
  "short_description": ComplexTextValue,
  "size": 123,
  "sku": "xyz789",
  "sleeve": "abc123",
  "small_image": ProductImage,
  "special_from_date": "xyz789",
  "special_price": 987.65,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "strap_bags": "xyz789",
  "style_bags": "xyz789",
  "style_bottom": "abc123",
  "style_general": "xyz789",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 123.45,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "abc123",
  "uid": "4",
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website],
  "weight": 123.45
}

GroupedProductItem

Description

(BETA) Contains information about an individual grouped product item.

Fields
Field Name Description
position - Int (BETA) The relative position of this item compared to the other group items.
product - ProductInterface (BETA) Details about this product option.
qty - Float (BETA) The quantity of this grouped product item.
Example
{
  "position": 123,
  "product": ProductInterface,
  "qty": 987.65
}

GroupedProductWishlistItem

Description

(BETA) A grouped product wish list item.

Fields
Field Name Description
added_at - String! (BETA) The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]! (BETA) Custom options selected for the wish list item.
description - String (BETA) The description of the item.
id - ID! (BETA) The unique ID for a WishlistItemInterface object.
product - ProductInterface (BETA) Product details of the wish list item.
quantity - Float! (BETA) The quantity of this wish list item.
Example
{
  "added_at": "abc123",
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "id": 4,
  "product": ProductInterface,
  "quantity": 987.65
}

HostedProInput

Description

(BETA) Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payments Pro Hosted Solution payment method.

Fields
Input Field Description
cancel_url - String!

(BETA) The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. For example, if the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.

return_url - String!

(BETA) The relative URL of the final confirmation page that PayPal redirects to upon payment success. For example, if the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.

Example
{
  "cancel_url": "abc123",
  "return_url": "abc123"
}

HostedProUrl

Description

(BETA) Contains the secure URL used for the Payments Pro Hosted Solution payment method.

Fields
Field Name Description
secure_form_url - String (BETA) The secure URL generated by PayPal.
Example
{"secure_form_url": "abc123"}

HostedProUrlInput

Description

(BETA) Contains the required input to request the secure URL for Payments Pro Hosted Solution payment.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID that identifies the shopper's cart.

Example
{"cart_id": "abc123"}

HttpQueryParameter

Description

(BETA) Contains target path parameters.

Fields
Field Name Description
name - String (BETA) A parameter name.
value - String (BETA) A parameter value.
Example
{
  "name": "xyz789",
  "value": "xyz789"
}

ID

Description

(BETA) The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
4

ImageSwatchData

Fields
Field Name Description
thumbnail - String (BETA) The URL assigned to the thumbnail of the swatch image.
value - String (BETA) The value can be represented as color (HEX code), image link, or text.
Example
{
  "thumbnail": "xyz789",
  "value": "abc123"
}

Int

Description

(BETA) The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
123

InternalError

Description

(BETA) Contains an error message when an internal error occurred.

Fields
Field Name Description
message - String! (BETA) The returned error message.
Example
{"message": "abc123"}

Invoice

Description

(BETA) Contains invoice details.

Fields
Field Name Description
comments - [SalesCommentItem] (BETA) Comments on the invoice.
id - ID! (BETA) The unique ID for a Invoice object.
items - [InvoiceItemInterface] (BETA) Invoiced product details.
number - String! (BETA) Sequential invoice number.
total - InvoiceTotal (BETA) Invoice total amount details.
Example
{
  "comments": [SalesCommentItem],
  "id": "4",
  "items": [InvoiceItemInterface],
  "number": "abc123",
  "total": InvoiceTotal
}

InvoiceItem

Fields
Field Name Description
discounts - [Discount] (BETA) Information about the final discount amount for the base product, including discounts on options.
id - ID! (BETA) The unique ID for an InvoiceItemInterface object.
order_item - OrderItemInterface (BETA) Details about an individual order item.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product including selected options.
product_sku - String! (BETA) The SKU of the base product.
quantity_invoiced - Float (BETA) The number of invoiced items.
Example
{
  "discounts": [Discount],
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_invoiced": 123.45
}

InvoiceItemInterface

Description

(BETA) Contains detailes about invoiced items.

Fields
Field Name Description
discounts - [Discount] (BETA) Information about the final discount amount for the base product, including discounts on options.
id - ID! (BETA) The unique ID for an InvoiceItemInterface object.
order_item - OrderItemInterface (BETA) Details about an individual order item.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product including selected options.
product_sku - String! (BETA) The SKU of the base product.
quantity_invoiced - Float (BETA) The number of invoiced items.
Possible Types
InvoiceItemInterface Types

DownloadableInvoiceItem

BundleInvoiceItem

GiftCardInvoiceItem

InvoiceItem

Example
{
  "discounts": [Discount],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_invoiced": 123.45
}

InvoiceTotal

Description

(BETA) Contains price details from an invoice.

Fields
Field Name Description
base_grand_total - Money! (BETA) The final base grand total amount in the base currency.
discounts - [Discount] (BETA) The applied discounts to the invoice.
grand_total - Money! (BETA) The final total amount, including shipping, discounts, and taxes.
shipping_handling - ShippingHandling (BETA) Details about the shipping and handling costs for the invoice.
subtotal - Money! (BETA) The subtotal of the invoice, excluding shipping, discounts, and taxes.
taxes - [TaxItem] (BETA) The invoice tax details.
total_shipping - Money! (BETA) The shipping amount for the invoice.
total_tax - Money! (BETA) The amount of tax applied to the invoice.
Example
{
  "base_grand_total": Money,
  "discounts": [Discount],
  "grand_total": Money,
  "shipping_handling": ShippingHandling,
  "subtotal": Money,
  "taxes": [TaxItem],
  "total_shipping": Money,
  "total_tax": Money
}

IsCompanyAdminEmailAvailableOutput

Description

(BETA) Contains the response of a company admin email validation query.

Fields
Field Name Description
is_email_available - Boolean! (BETA) Indicates whether the specified email address can be used to create a company administrator.
Example
{"is_email_available": true}

IsCompanyEmailAvailableOutput

Description

(BETA) Contains the response of a company email validation query.

Fields
Field Name Description
is_email_available - Boolean! (BETA) Indicates whether the specified email address can be used to create a company.
Example
{"is_email_available": false}

IsCompanyRoleNameAvailableOutput

Description

(BETA) Contains the response of a role name validation query.

Fields
Field Name Description
is_role_name_available - Boolean! (BETA) Indicates whether the specified company role name is available.
Example
{"is_role_name_available": true}

IsCompanyUserEmailAvailableOutput

Description

(BETA) Contains the response of a company user email validation query.

Fields
Field Name Description
is_email_available - Boolean! (BETA) Indicates whether the specified email address can be used to create a company user.
Example
{"is_email_available": true}

IsEmailAvailableOutput

Description

(BETA) Contains the result of the isEmailAvailable query.

Fields
Field Name Description
is_email_available - Boolean (BETA) Indicates whether the specified email address can be used to create a customer.
Example
{"is_email_available": false}

ItemSelectedBundleOption

Description

(BETA) A list of options of the selected bundle product.

Fields
Field Name Description
id - ID! (BETA) The unique ID for a ItemSelectedBundleOption object. Use uid instead.
label - String! (BETA) The label of the option.
uid - ID! (BETA) The unique ID for a ItemSelectedBundleOption object.
values - [ItemSelectedBundleOptionValue] (BETA) A list of products that represent the values of the parent option.
Example
{
  "id": "4",
  "label": "abc123",
  "uid": "4",
  "values": [ItemSelectedBundleOptionValue]
}

ItemSelectedBundleOptionValue

Description

(BETA) A list of values for the selected bundle product.

Fields
Field Name Description
id - ID! (BETA) The unique ID for a ItemSelectedBundleOptionValue object. Use uid instead.
price - Money! (BETA) The price of the child bundle product.
product_name - String! (BETA) The name of the child bundle product.
product_sku - String! (BETA) The SKU of the child bundle product.
quantity - Float! (BETA) The number of this bundle product that were ordered.
uid - ID! (BETA) The unique ID for a ItemSelectedBundleOptionValue object.
Example
{
  "id": 4,
  "price": Money,
  "product_name": "abc123",
  "product_sku": "abc123",
  "quantity": 987.65,
  "uid": 4
}

KeyValue

Description

(BETA) Contains a key-value pair.

Fields
Field Name Description
name - String (BETA) The name part of the key/value pair.
value - String (BETA) The value part of the key/value pair.
Example
{
  "name": "xyz789",
  "value": "xyz789"
}

LayerFilter

Description

(BETA) Contains information for rendering layered navigation.

Fields
Field Name Description
filter_items - [LayerFilterItemInterface] (BETA) An array of filter items. Use Aggregation.options instead.
filter_items_count - Int (BETA) The count of filter items in filter group. Use Aggregation.count instead.
name - String (BETA) The name of a layered navigation filter. Use Aggregation.label instead.
request_var - String (BETA) The request variable name for a filter query. Use Aggregation.attribute_code instead.
Example
{
  "filter_items": [LayerFilterItemInterface],
  "filter_items_count": 123,
  "name": "abc123",
  "request_var": "abc123"
}

LayerFilterItem

Fields
Field Name Description
items_count - Int (BETA) The count of items per filter. Use AggregationOption.count instead.
label - String (BETA) The label for a filter. Use AggregationOption.label instead.
value_string - String (BETA) The value of a filter request variable to be used in query. Use AggregationOption.value instead.
Example
{
  "items_count": 123,
  "label": "xyz789",
  "value_string": "xyz789"
}

LayerFilterItemInterface

Fields
Field Name Description
items_count - Int (BETA) The count of items per filter. Use AggregationOption.count instead.
label - String (BETA) The label for a filter. Use AggregationOption.label instead.
value_string - String (BETA) The value of a filter request variable to be used in query. Use AggregationOption.value instead.
Possible Types
LayerFilterItemInterface Types

LayerFilterItem

SwatchLayerFilterItem

Example
{
  "items_count": 987,
  "label": "abc123",
  "value_string": "xyz789"
}

MediaGalleryEntry

Description

(BETA) Defines characteristics about images and videos associated with a specific product.

Fields
Field Name Description
content - ProductMediaGalleryEntriesContent (BETA) Details about the content of the media gallery item.
disabled - Boolean (BETA) Indicates whether the image is hidden from view.
file - String (BETA) The path of the image on the server.
id - Int (BETA) The identifier assigned to the object. Use uid instead.
label - String (BETA) The alt text displayed on the storefront when the user points to the image.
media_type - String (BETA) Either image or video.
position - Int (BETA) The media item's position after it has been sorted.
types - [String] (BETA) Array of image types. It can have the following values: image, small_image, thumbnail.
uid - ID! (BETA) The unique ID for a MediaGalleryEntry object.
video_content - ProductMediaGalleryEntriesVideoContent (BETA) Details about the content of a video item.
Example
{
  "content": ProductMediaGalleryEntriesContent,
  "disabled": true,
  "file": "abc123",
  "id": 123,
  "label": "xyz789",
  "media_type": "xyz789",
  "position": 987,
  "types": ["abc123"],
  "uid": "4",
  "video_content": ProductMediaGalleryEntriesVideoContent
}

MediaGalleryInterface

Description

(BETA) Contains basic information about a product image or video.

Fields
Field Name Description
disabled - Boolean (BETA) Indicates whether the image is hidden from view.
label - String (BETA) The label of the product image or video.
position - Int (BETA) The media item's position after it has been sorted.
url - String (BETA) The URL of the product image or video.
Possible Types
MediaGalleryInterface Types

ProductImage

ProductVideo

Example
{
  "disabled": false,
  "label": "abc123",
  "position": 987,
  "url": "abc123"
}

Money

Description

(BETA) Defines a monetary value, including a numeric value and a currency code.

Fields
Field Name Description
currency - CurrencyEnum (BETA) A three-letter currency code, such as USD or EUR.
value - Float (BETA) A number expressing a monetary value.
Example
{"currency": "AFN", "value": 987.65}

MoveCartItemsToGiftRegistryOutput

Description

(BETA) Contains the customer's gift registry and any errors encountered.

Fields
Field Name Description
gift_registry - GiftRegistry (BETA) The gift registry.
status - Boolean! (BETA) Indicates whether the attempt to move the cart items to the gift registry was successful.
user_errors - [GiftRegistryItemsUserError]! (BETA) An array of errors encountered while moving items from the cart to the gift registry.
Example
{
  "gift_registry": GiftRegistry,
  "status": true,
  "user_errors": [GiftRegistryItemsUserError]
}

MoveItemsBetweenRequisitionListsInput

Description

(BETA) An input object that defines the items in a requisition list to be moved.

Fields
Input Field Description
requisitionListItemUids - [ID]!

(BETA) An array of IDs representing products moved from one requisition list to another.

Example
{"requisitionListItemUids": ["4"]}

MoveItemsBetweenRequisitionListsOutput

Description

(BETA) Output of the request to move items to another requisition list.

Fields
Field Name Description
destination_requisition_list - RequisitionList (BETA) The destination requisition list after moving items.
source_requisition_list - RequisitionList (BETA) The source requisition list after moving items.
Example
{
  "destination_requisition_list": RequisitionList,
  "source_requisition_list": RequisitionList
}

MoveProductsBetweenWishlistsOutput

Description

(BETA) Contains the source and target wish lists after moving products.

Fields
Field Name Description
destination_wishlist - Wishlist! (BETA) The destination wish list after receiving products moved from the source wish list.
source_wishlist - Wishlist! (BETA) The source wish list after moving products from it.
user_errors - [WishListUserInputError]! (BETA) An array of errors encountered while moving products to a wish list.
Example
{
  "destination_wishlist": Wishlist,
  "source_wishlist": Wishlist,
  "user_errors": [WishListUserInputError]
}

NegotiableQuote

Description

(BETA) Contains details about a negotiable quote.

Fields
Field Name Description
available_payment_methods - [AvailablePaymentMethod] (BETA) An array of payment methods that can be applied to the negotiable quote.
billing_address - NegotiableQuoteBillingAddress (BETA) The billing address applied to the negotiable quote.
buyer - NegotiableQuoteUser! (BETA) The first and last name of the buyer.
comments - [NegotiableQuoteComment] (BETA) A list of comments made by the buyer and seller.
created_at - String (BETA) Timestamp indicating when the negotiable quote was created.
email - String (BETA) The email address of the company user.
history - [NegotiableQuoteHistoryEntry] (BETA) A list of status and price changes for the negotiable quote.
is_virtual - Boolean! (BETA) Indicates whether the negotiable quote contains only virtual products.
items - [CartItemInterface] (BETA) The list of items in the negotiable quote.
name - String! (BETA) The title assigned to the negotiable quote.
prices - CartPrices (BETA) A set of subtotals and totals applied to the negotiable quote.
selected_payment_method - SelectedPaymentMethod (BETA) The payment method that was applied to the negotiable quote.
shipping_addresses - [NegotiableQuoteShippingAddress]! (BETA) A list of shipping addresses applied to the negotiable quote.
status - NegotiableQuoteStatus! (BETA) The status of the negotiable quote.
total_quantity - Float! (BETA) The total number of items in the negotiable quote.
uid - ID! (BETA) The unique ID of a NegotiableQuote object.
updated_at - String (BETA) Timestamp indicating when the negotiable quote was updated.
Example
{
  "available_payment_methods": [AvailablePaymentMethod],
  "billing_address": NegotiableQuoteBillingAddress,
  "buyer": NegotiableQuoteUser,
  "comments": [NegotiableQuoteComment],
  "created_at": "xyz789",
  "email": "abc123",
  "history": [NegotiableQuoteHistoryEntry],
  "is_virtual": false,
  "items": [CartItemInterface],
  "name": "xyz789",
  "prices": CartPrices,
  "selected_payment_method": SelectedPaymentMethod,
  "shipping_addresses": [NegotiableQuoteShippingAddress],
  "status": "SUBMITTED",
  "total_quantity": 123.45,
  "uid": 4,
  "updated_at": "xyz789"
}

NegotiableQuoteAddressCountry

Description

(BETA) Defines the company's country.

Fields
Field Name Description
code - String! (BETA) The address country code.
label - String! (BETA) The display name of the region.
Example
{
  "code": "xyz789",
  "label": "abc123"
}

NegotiableQuoteAddressInput

Description

(BETA) Defines the billing or shipping address to be applied to the cart.

Fields
Input Field Description
city - String!

(BETA) The city specified for the billing or shipping address.

company - String

(BETA) The company name.

country_code - String!

(BETA) The country code and label for the billing or shipping address.

firstname - String!

(BETA) The first name of the company user.

lastname - String!

(BETA) The last name of the company user.

postcode - String

(BETA) The ZIP or postal code of the billing or shipping address.

region - String

(BETA) A string that defines the state or province of the billing or shipping address.

region_id - Int

(BETA) An integer that defines the state or province of the billing or shipping address.

save_in_address_book - Boolean

(BETA) Determines whether to save the address in the customer's address book. The default value is true.

street - [String]!

(BETA) An array containing the street for the billing or shipping address.

telephone - String

(BETA) The telephone number for the billing or shipping address.

Example
{
  "city": "abc123",
  "company": "xyz789",
  "country_code": "abc123",
  "firstname": "abc123",
  "lastname": "xyz789",
  "postcode": "xyz789",
  "region": "xyz789",
  "region_id": 123,
  "save_in_address_book": true,
  "street": ["abc123"],
  "telephone": "xyz789"
}

NegotiableQuoteAddressInterface

Fields
Field Name Description
city - String! (BETA) The company's city or town.
company - String (BETA) The company name associated with the shipping/billing address.
country - NegotiableQuoteAddressCountry! (BETA) The company's country.
firstname - String! (BETA) The first name of the company user.
lastname - String! (BETA) The last name of the company user.
postcode - String (BETA) The company's ZIP or postal code.
region - NegotiableQuoteAddressRegion (BETA) An object containing the region name, region code, and region ID.
street - [String]! (BETA) An array of strings that define the street number and name.
telephone - String (BETA) The customer's telephone number.
Possible Types
NegotiableQuoteAddressInterface Types

NegotiableQuoteShippingAddress

NegotiableQuoteBillingAddress

Example
{
  "city": "xyz789",
  "company": "abc123",
  "country": NegotiableQuoteAddressCountry,
  "firstname": "xyz789",
  "lastname": "xyz789",
  "postcode": "abc123",
  "region": NegotiableQuoteAddressRegion,
  "street": ["xyz789"],
  "telephone": "xyz789"
}

NegotiableQuoteAddressRegion

Description

(BETA) Defines the company's state or province.

Fields
Field Name Description
code - String (BETA) The address region code.
label - String (BETA) The display name of the region.
region_id - Int (BETA) The unique ID for a pre-defined region.
Example
{
  "code": "xyz789",
  "label": "xyz789",
  "region_id": 987
}

NegotiableQuoteBillingAddress

Fields
Field Name Description
city - String! (BETA) The company's city or town.
company - String (BETA) The company name associated with the shipping/billing address.
country - NegotiableQuoteAddressCountry! (BETA) The company's country.
firstname - String! (BETA) The first name of the company user.
lastname - String! (BETA) The last name of the company user.
postcode - String (BETA) The company's ZIP or postal code.
region - NegotiableQuoteAddressRegion (BETA) An object containing the region name, region code, and region ID.
street - [String]! (BETA) An array of strings that define the street number and name.
telephone - String (BETA) The customer's telephone number.
Example
{
  "city": "abc123",
  "company": "abc123",
  "country": NegotiableQuoteAddressCountry,
  "firstname": "xyz789",
  "lastname": "abc123",
  "postcode": "xyz789",
  "region": NegotiableQuoteAddressRegion,
  "street": ["abc123"],
  "telephone": "xyz789"
}

NegotiableQuoteBillingAddressInput

Description

(BETA) Defines the billing address.

Fields
Input Field Description
address - NegotiableQuoteAddressInput

(BETA) Defines a billing address.

customer_address_uid - ID

(BETA) The unique ID of a CustomerAddress object.

same_as_shipping - Boolean

(BETA) Indicates whether to set the billing address to be the same as the existing shipping address on the negotiable quote.

use_for_shipping - Boolean

(BETA) Indicates whether to set the shipping address to be the same as this billing address.

Example
{
  "address": NegotiableQuoteAddressInput,
  "customer_address_uid": "4",
  "same_as_shipping": true,
  "use_for_shipping": true
}

NegotiableQuoteComment

Description

(BETA) Contains a single plain text comment from either the buyer or seller.

Fields
Field Name Description
author - NegotiableQuoteUser! (BETA) The first and last name of the commenter.
created_at - String! (BETA) Timestamp indicating when the comment was created.
creator_type - NegotiableQuoteCommentCreatorType! (BETA) Indicates whether a buyer or seller commented.
text - String! (BETA) The plain text comment.
uid - ID! (BETA) The unique ID of a NegotiableQuoteComment object.
Example
{
  "author": NegotiableQuoteUser,
  "created_at": "abc123",
  "creator_type": "BUYER",
  "text": "xyz789",
  "uid": "4"
}

NegotiableQuoteCommentCreatorType

Values
Enum Value Description

BUYER

SELLER

Example
"BUYER"

NegotiableQuoteCommentInput

Description

(BETA) Contains the commend provided by the buyer.

Fields
Input Field Description
comment - String!

(BETA) The comment provided by the buyer.

Example
{"comment": "abc123"}

NegotiableQuoteCustomLogChange

Description

(BETA) Contains custom log entries added by third-party extensions.

Fields
Field Name Description
new_value - String! (BETA) The new entry content.
old_value - String (BETA) The previous entry in the custom log.
title - String! (BETA) The title of the custom log entry.
Example
{
  "new_value": "xyz789",
  "old_value": "abc123",
  "title": "abc123"
}

NegotiableQuoteFilterInput

Description

(BETA) Defines a filter to limit the negotiable quotes to return.

Fields
Input Field Description
ids - FilterEqualTypeInput

(BETA) Filter by the ID of one or more negotiable quotes.

name - FilterMatchTypeInput

(BETA) Filter by the negotiable quote name.

Example
{
  "ids": FilterEqualTypeInput,
  "name": FilterMatchTypeInput
}

NegotiableQuoteHistoryChanges

Description

(BETA) Contains a list of changes to a negotiable quote.

Fields
Field Name Description
comment_added - NegotiableQuoteHistoryCommentChange (BETA) The comment provided with a change in the negotiable quote history.
custom_changes - NegotiableQuoteCustomLogChange (BETA) Lists log entries added by third-party extensions.
expiration - NegotiableQuoteHistoryExpirationChange (BETA) The expiration date of the negotiable quote before and after a change in the quote history.
products_removed - NegotiableQuoteHistoryProductsRemovedChange (BETA) Lists products that were removed as a result of a change in the quote history.
statuses - NegotiableQuoteHistoryStatusesChange (BETA) The status before and after a change in the negotiable quote history.
total - NegotiableQuoteHistoryTotalChange (BETA) The total amount of the negotiable quote before and after a change in the quote history.
Example
{
  "comment_added": NegotiableQuoteHistoryCommentChange,
  "custom_changes": NegotiableQuoteCustomLogChange,
  "expiration": NegotiableQuoteHistoryExpirationChange,
  "products_removed": NegotiableQuoteHistoryProductsRemovedChange,
  "statuses": NegotiableQuoteHistoryStatusesChange,
  "total": NegotiableQuoteHistoryTotalChange
}

NegotiableQuoteHistoryCommentChange

Description

(BETA) Contains a comment submitted by a seller or buyer.

Fields
Field Name Description
comment - String! (BETA) A plain text comment submitted by a seller or buyer.
Example
{"comment": "xyz789"}

NegotiableQuoteHistoryEntry

Description

(BETA) Contains details about a change for a negotiable quote.

Fields
Field Name Description
author - NegotiableQuoteUser! (BETA) The person who made a change in the status of the negotiable quote.
change_type - NegotiableQuoteHistoryEntryChangeType! (BETA) An enum that describes the why the entry in the negotiable quote history changed status.
changes - NegotiableQuoteHistoryChanges (BETA) The set of changes in the negotiable quote.
created_at - String (BETA) Timestamp indicating when the negotiable quote entry was created.
uid - ID! (BETA) The unique ID of a NegotiableQuoteHistoryEntry object.
Example
{
  "author": NegotiableQuoteUser,
  "change_type": "CREATED",
  "changes": NegotiableQuoteHistoryChanges,
  "created_at": "xyz789",
  "uid": "4"
}

NegotiableQuoteHistoryEntryChangeType

Values
Enum Value Description

CREATED

UPDATED

CLOSED

UPDATED_BY_SYSTEM

Example
"CREATED"

NegotiableQuoteHistoryExpirationChange

Description

(BETA) Contains a new expiration date and the previous date.

Fields
Field Name Description
new_expiration - String (BETA) The expiration date after the change. The value will be 'null' if not set.
old_expiration - String (BETA) The previous expiration date. The value will be 'null' if not previously set.
Example
{
  "new_expiration": "xyz789",
  "old_expiration": "abc123"
}

NegotiableQuoteHistoryProductsRemovedChange

Description

(BETA) Contains lists of products that have been removed from the catalog and negotiable quote.

Fields
Field Name Description
products_removed_from_catalog - [ID] (BETA) A list of product IDs the seller removed from the catalog.
products_removed_from_quote - [ProductInterface] (BETA) A list of products removed from the negotiable quote by either the buyer or the seller.
Example
{
  "products_removed_from_catalog": [4],
  "products_removed_from_quote": [ProductInterface]
}

NegotiableQuoteHistoryStatusChange

Description

(BETA) Lists a new status change applied to a negotiable quote and the previous status.

Fields
Field Name Description
new_status - NegotiableQuoteStatus! (BETA) The updated status.
old_status - NegotiableQuoteStatus (BETA) The previous status. The value will be null for the first history entry in a negotiable quote.
Example
{"new_status": "SUBMITTED", "old_status": "SUBMITTED"}

NegotiableQuoteHistoryStatusesChange

Description

(BETA) Contains a list of status changes that occurred for the negotiable quote.

Fields
Field Name Description
changes - [NegotiableQuoteHistoryStatusChange]! (BETA) A list of status changes.
Example
{"changes": [NegotiableQuoteHistoryStatusChange]}

NegotiableQuoteHistoryTotalChange

Description

(BETA) Contains a new price and the previous price.

Fields
Field Name Description
new_price - Money (BETA) The total price as a result of the change.
old_price - Money (BETA) The previous total price on the negotiable quote.
Example
{
  "new_price": Money,
  "old_price": Money
}

NegotiableQuoteInvalidStateError

Description

(BETA) An error indicating that an operation was attempted on a negotiable quote in an invalid state.

Fields
Field Name Description
message - String! (BETA) The returned error message.
Example
{"message": "abc123"}

NegotiableQuoteItemQuantityInput

Description

(BETA) Specifies the updated quantity of an item.

Fields
Input Field Description
quantity - Float!

(BETA) The new quantity of the negotiable quote item.

quote_item_uid - ID!

(BETA) The unique ID of a CartItemInterface object.

Example
{"quantity": 123.45, "quote_item_uid": "4"}

NegotiableQuotePaymentMethodInput

Description

(BETA) Defines the payment method to be applied to the negotiable quote.

Fields
Input Field Description
code - String!

(BETA) Payment method code

purchase_order_number - String

(BETA) The purchase order number. Optional for most payment methods.

Example
{
  "code": "abc123",
  "purchase_order_number": "abc123"
}

NegotiableQuoteShippingAddress

Fields
Field Name Description
available_shipping_methods - [AvailableShippingMethod] (BETA) An array of shipping methods available to the buyer.
city - String! (BETA) The company's city or town.
company - String (BETA) The company name associated with the shipping/billing address.
country - NegotiableQuoteAddressCountry! (BETA) The company's country.
firstname - String! (BETA) The first name of the company user.
lastname - String! (BETA) The last name of the company user.
postcode - String (BETA) The company's ZIP or postal code.
region - NegotiableQuoteAddressRegion (BETA) An object containing the region name, region code, and region ID.
selected_shipping_method - SelectedShippingMethod (BETA) The selected shipping method.
street - [String]! (BETA) An array of strings that define the street number and name.
telephone - String (BETA) The customer's telephone number.
Example
{
  "available_shipping_methods": [AvailableShippingMethod],
  "city": "abc123",
  "company": "abc123",
  "country": NegotiableQuoteAddressCountry,
  "firstname": "abc123",
  "lastname": "xyz789",
  "postcode": "abc123",
  "region": NegotiableQuoteAddressRegion,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["xyz789"],
  "telephone": "abc123"
}

NegotiableQuoteShippingAddressInput

Description

(BETA) Defines shipping addresses for the negotiable quote.

Fields
Input Field Description
address - NegotiableQuoteAddressInput

(BETA) A shipping address.

customer_address_uid - ID

(BETA) An ID from the company user's address book that uniquely identifies the address to be used for shipping.

customer_notes - String

(BETA) Text provided by the company user.

Example
{
  "address": NegotiableQuoteAddressInput,
  "customer_address_uid": 4,
  "customer_notes": "xyz789"
}

NegotiableQuoteSortInput

Description

(BETA) Defines the field to use to sort a list of negotiable quotes.

Fields
Input Field Description
sort_direction - SortEnum!

(BETA) Whether to return results in ascending or descending order.

sort_field - NegotiableQuoteSortableField!

(BETA) The specified sort field.

Example
{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"}

NegotiableQuoteSortableField

Values
Enum Value Description

QUOTE_NAME

(BETA) Sorts negotiable quotes by name.

CREATED_AT

(BETA) Sorts negotiable quotes by the dates they were created.

UPDATED_AT

(BETA) Sorts negotiable quotes by the dates they were last modified.
Example
"QUOTE_NAME"

NegotiableQuoteStatus

Values
Enum Value Description

SUBMITTED

PENDING

UPDATED

OPEN

ORDERED

CLOSED

DECLINED

EXPIRED

Example
"SUBMITTED"

NegotiableQuoteUidNonFatalResultInterface

Fields
Field Name Description
quote_uid - ID! (BETA) The unique ID of a NegotiableQuote object.
Possible Types
NegotiableQuoteUidNonFatalResultInterface Types

NegotiableQuoteUidOperationSuccess

Example
{"quote_uid": 4}

NegotiableQuoteUidOperationSuccess

Description

(BETA) Contains details about a successful operation on a negotiable quote.

Fields
Field Name Description
quote_uid - ID! (BETA) The unique ID of a NegotiableQuote object.
Example
{"quote_uid": "4"}

NegotiableQuoteUser

Description

(BETA) A limited view of a Buyer or Seller in the negotiable quote process.

Fields
Field Name Description
firstname - String! (BETA) The first name of the buyer or seller making a change.
lastname - String! (BETA) The buyer's or seller's last name.
Example
{
  "firstname": "xyz789",
  "lastname": "abc123"
}

NegotiableQuotesOutput

Description

(BETA) Contains a list of negotiable that match the specified filter.

Fields
Field Name Description
items - [NegotiableQuote]! (BETA) A list of negotiable quotes
page_info - SearchResultPageInfo! (BETA) Contains pagination metadata
sort_fields - SortFields (BETA) Contains the default sort field and all available sort fields.
total_count - Int! (BETA) The number of negotiable quotes returned
Example
{
  "items": [NegotiableQuote],
  "page_info": SearchResultPageInfo,
  "sort_fields": SortFields,
  "total_count": 987
}

NoSuchEntityUidError

Description

(BETA) Contains an error message when an invalid UID was specified.

Fields
Field Name Description
message - String! (BETA) The returned error message.
uid - ID! (BETA) The specified invalid unique ID of an object.
Example
{
  "message": "abc123",
  "uid": "4"
}

Order

Description

(BETA) Contains the order ID.

Fields
Field Name Description
order_id - String Use order_number instead.
order_number - String! (BETA) The unique ID for an Order object.
Example
{
  "order_id": "xyz789",
  "order_number": "xyz789"
}

OrderAddress

Description

(BETA) Contains detailed information about an order's billing and shipping addresses.

Fields
Field Name Description
city - String! (BETA) The city or town.
company - String (BETA) The customer's company.
country_code - CountryCodeEnum (BETA) The customer's country.
fax - String (BETA) The fax number.
firstname - String! (BETA) The first name of the person associated with the shipping/billing address.
lastname - String! (BETA) The family name of the person associated with the shipping/billing address.
middlename - String (BETA) The middle name of the person associated with the shipping/billing address.
postcode - String (BETA) The customer's ZIP or postal code.
prefix - String (BETA) An honorific, such as Dr., Mr., or Mrs.
region - String (BETA) The state or province name.
region_id - ID (BETA) The unique ID for a Region object of a pre-defined region.
street - [String]! (BETA) An array of strings that define the street number and name.
suffix - String (BETA) A value such as Sr., Jr., or III.
telephone - String (BETA) The telephone number.
vat_id - String (BETA) The customer's Value-added tax (VAT) number (for corporate customers).
Example
{
  "city": "abc123",
  "company": "xyz789",
  "country_code": "AF",
  "fax": "xyz789",
  "firstname": "abc123",
  "lastname": "xyz789",
  "middlename": "xyz789",
  "postcode": "abc123",
  "prefix": "xyz789",
  "region": "abc123",
  "region_id": 4,
  "street": ["abc123"],
  "suffix": "xyz789",
  "telephone": "xyz789",
  "vat_id": "abc123"
}

OrderItem

Fields
Field Name Description
discounts - [Discount] (BETA) The final discount information for the product.
eligible_for_return - Boolean (BETA) Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption] (BETA) The entered option for the base product, such as a logo or image.
gift_message - GiftMessage (BETA) The selected gift message for the order item
gift_wrapping - GiftWrapping (BETA) The selected gift wrapping for the order item.
id - ID! (BETA) The unique ID for an OrderItemInterface object.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price of the base product, including selected options.
product_sku - String! (BETA) The SKU of the base product.
product_type - String (BETA) The type of product, such as simple, configurable, etc.
product_url_key - String (BETA) URL key of the base product.
quantity_canceled - Float (BETA) The number of canceled items.
quantity_invoiced - Float (BETA) The number of invoiced items.
quantity_ordered - Float (BETA) The number of units ordered for this item.
quantity_refunded - Float (BETA) The number of refunded items.
quantity_returned - Float (BETA) The number of returned items.
quantity_shipped - Float (BETA) The number of shipped items.
selected_options - [OrderItemOption] (BETA) The selected options for the base product, such as color or size.
status - String (BETA) The status of the order item.
Example
{
  "discounts": [Discount],
  "eligible_for_return": false,
  "entered_options": [OrderItemOption],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": 4,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "product_type": "xyz789",
  "product_url_key": "abc123",
  "quantity_canceled": 123.45,
  "quantity_invoiced": 123.45,
  "quantity_ordered": 123.45,
  "quantity_refunded": 987.65,
  "quantity_returned": 987.65,
  "quantity_shipped": 987.65,
  "selected_options": [OrderItemOption],
  "status": "abc123"
}

OrderItemInterface

Description

(BETA) Order item details.

Fields
Field Name Description
discounts - [Discount] (BETA) The final discount information for the product.
eligible_for_return - Boolean (BETA) Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption] (BETA) The entered option for the base product, such as a logo or image.
gift_message - GiftMessage (BETA) The selected gift message for the order item
gift_wrapping - GiftWrapping (BETA) The selected gift wrapping for the order item.
id - ID! (BETA) The unique ID for an OrderItemInterface object.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price of the base product, including selected options.
product_sku - String! (BETA) The SKU of the base product.
product_type - String (BETA) The type of product, such as simple, configurable, etc.
product_url_key - String (BETA) URL key of the base product.
quantity_canceled - Float (BETA) The number of canceled items.
quantity_invoiced - Float (BETA) The number of invoiced items.
quantity_ordered - Float (BETA) The number of units ordered for this item.
quantity_refunded - Float (BETA) The number of refunded items.
quantity_returned - Float (BETA) The number of returned items.
quantity_shipped - Float (BETA) The number of shipped items.
selected_options - [OrderItemOption] (BETA) The selected options for the base product, such as color or size.
status - String (BETA) The status of the order item.
Possible Types
OrderItemInterface Types

DownloadableOrderItem

BundleOrderItem

GiftCardOrderItem

OrderItem

Example
{
  "discounts": [Discount],
  "eligible_for_return": false,
  "entered_options": [OrderItemOption],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": 4,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "product_type": "abc123",
  "product_url_key": "abc123",
  "quantity_canceled": 987.65,
  "quantity_invoiced": 987.65,
  "quantity_ordered": 123.45,
  "quantity_refunded": 123.45,
  "quantity_returned": 123.45,
  "quantity_shipped": 987.65,
  "selected_options": [OrderItemOption],
  "status": "abc123"
}

OrderItemOption

Description

(BETA) Represents order item options like selected or entered.

Fields
Field Name Description
label - String! (BETA) The name of the option.
value - String! (BETA) The value of the option.
Example
{
  "label": "abc123",
  "value": "abc123"
}

OrderPaymentMethod

Description

(BETA) Contains details about the payment method used to pay for the order.

Fields
Field Name Description
additional_data - [KeyValue] (BETA) Additional data per payment method type.
name - String! (BETA) The label that describes the payment method.
type - String! (BETA) The payment method code that indicates how the order was paid for.
Example
{
  "additional_data": [KeyValue],
  "name": "xyz789",
  "type": "xyz789"
}

OrderShipment

Description

(BETA) Contains order shipment details.

Fields
Field Name Description
comments - [SalesCommentItem] (BETA) Comments added to the shipment.
id - ID! (BETA) The unique ID for a OrderShipment object.
items - [ShipmentItemInterface] (BETA) An array of items included in the shipment.
number - String! (BETA) The sequential credit shipment number.
tracking - [ShipmentTracking] (BETA) An array of shipment tracking details.
Example
{
  "comments": [SalesCommentItem],
  "id": "4",
  "items": [ShipmentItemInterface],
  "number": "xyz789",
  "tracking": [ShipmentTracking]
}

OrderTotal

Description

(BETA) Contains details about the sales total amounts used to calculate the final price.

Fields
Field Name Description
base_grand_total - Money! (BETA) The final base grand total amount in the base currency.
discounts - [Discount] (BETA) The applied discounts to the order.
grand_total - Money! (BETA) The final total amount, including shipping, discounts, and taxes.
shipping_handling - ShippingHandling (BETA) Details about the shipping and handling costs for the order.
subtotal - Money! (BETA) The subtotal of the order, excluding shipping, discounts, and taxes.
taxes - [TaxItem] (BETA) The order tax details.
total_giftcard - Money (BETA) The gift card balance applied to the order.
total_shipping - Money! (BETA) The shipping amount for the order.
total_tax - Money! (BETA) The amount of tax applied to the order.
Example
{
  "base_grand_total": Money,
  "discounts": [Discount],
  "grand_total": Money,
  "shipping_handling": ShippingHandling,
  "subtotal": Money,
  "taxes": [TaxItem],
  "total_giftcard": Money,
  "total_shipping": Money,
  "total_tax": Money
}

PayflowExpressInput

Description

(BETA) Contains required input for Payflow Express Checkout payments.

Fields
Input Field Description
payer_id - String!

(BETA) The unique ID of the PayPal user.

token - String!

(BETA) The token returned by the createPaypalExpressToken mutation.

Example
{
  "payer_id": "xyz789",
  "token": "abc123"
}

PayflowLinkInput

Description

(BETA) A set of relative URLs that PayPal uses in response to various actions during the authorization process. Adobe Commerce prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payflow Link and Payments Advanced payment methods.

Fields
Input Field Description
cancel_url - String!

(BETA) The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.

error_url - String!

(BETA) The relative URL of the transaction error page that PayPal redirects to upon payment error. If the full URL to this page is https://www.example.com/paypal/action/error.html, the relative URL is paypal/action/error.html.

return_url - String!

(BETA) The relative URL of the order confirmation page that PayPal redirects to when the payment is successful and additional confirmation is not needed. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.

Example
{
  "cancel_url": "xyz789",
  "error_url": "abc123",
  "return_url": "abc123"
}

PayflowLinkMode

Description

(BETA) Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods.

Values
Enum Value Description

TEST

LIVE

Example
"TEST"

PayflowLinkToken

Description

(BETA) Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods.

Fields
Field Name Description
mode - PayflowLinkMode (BETA) The mode for the Payflow transaction.
paypal_url - String (BETA) The PayPal URL used for requesting a Payflow form.
secure_token - String (BETA) The secure token generated by PayPal.
secure_token_id - String (BETA) The secure token ID generated by PayPal.
Example
{
  "mode": "TEST",
  "paypal_url": "xyz789",
  "secure_token": "xyz789",
  "secure_token_id": "xyz789"
}

PayflowLinkTokenInput

Description

(BETA) Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID that identifies the customer's cart.

Example
{"cart_id": "abc123"}

PayflowProInput

Description

(BETA) Contains input for the Payflow Pro and Payments Pro payment methods.

Fields
Input Field Description
cc_details - CreditCardDetailsInput!

(BETA) Required input for credit card related information.

is_active_payment_token_enabler - Boolean

(BETA) Indicates whether details about the shopper's credit/debit card should be tokenized for later usage. Required only if Vault is enabled for the PayPal Payflow Pro payment integration.

Example
{
  "cc_details": CreditCardDetailsInput,
  "is_active_payment_token_enabler": false
}

PayflowProResponseInput

Description

(BETA) Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID that identifies the shopper's cart.

paypal_payload - String!

(BETA) The payload returned from PayPal.

Example
{
  "cart_id": "abc123",
  "paypal_payload": "abc123"
}

PayflowProResponseOutput

Fields
Field Name Description
cart - Cart! (BETA) The cart with the updated selected payment method.
Example
{"cart": Cart}

PayflowProTokenInput

Description

(BETA) Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID that identifies the shopper's cart.

urls - PayflowProUrlInput!

(BETA) A set of relative URLs that PayPal uses for callback.

Example
{
  "cart_id": "abc123",
  "urls": PayflowProUrlInput
}

PayflowProUrlInput

Description

(BETA) Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for the Payflow Pro and Payment Pro payment methods.

Fields
Input Field Description
cancel_url - String!

(BETA) The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.

error_url - String!

(BETA) The relative URL of the transaction error page that PayPal redirects to upon payment error. If the full URL to this page is https://www.example.com/paypal/action/error.html, the relative URL is paypal/action/error.html.

return_url - String!

(BETA) The relative URL of the final confirmation page that PayPal redirects to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.

Example
{
  "cancel_url": "xyz789",
  "error_url": "xyz789",
  "return_url": "abc123"
}

PaymentMethodInput

Description

(BETA) Defines the payment method.

Fields
Input Field Description
braintree - BraintreeInput
braintree_cc_vault - BraintreeCcVaultInput
code - String!

(BETA) The internal name for the payment method.

hosted_pro - HostedProInput

(BETA) Required input for PayPal Hosted pro payments.

payflow_express - PayflowExpressInput

(BETA) Required input for Payflow Express Checkout payments.

payflow_link - PayflowLinkInput

(BETA) Required input for PayPal Payflow Link and Payments Advanced payments.

payflowpro - PayflowProInput

(BETA) Required input for PayPal Payflow Pro and Payment Pro payments.

payflowpro_cc_vault - VaultTokenInput

(BETA) Required input for PayPal Payflow Pro vault payments.

paypal_express - PaypalExpressInput

(BETA) Required input for Express Checkout and Payments Standard payments.

purchase_order_number - String

(BETA) The purchase order number. Optional for most payment methods.

Example
{
  "braintree": BraintreeInput,
  "braintree_cc_vault": BraintreeCcVaultInput,
  "code": "xyz789",
  "hosted_pro": HostedProInput,
  "payflow_express": PayflowExpressInput,
  "payflow_link": PayflowLinkInput,
  "payflowpro": PayflowProInput,
  "payflowpro_cc_vault": VaultTokenInput,
  "paypal_express": PaypalExpressInput,
  "purchase_order_number": "xyz789"
}

PaymentToken

Description

(BETA) The stored payment method available to the customer.

Fields
Field Name Description
details - String (BETA) A description of the stored account details.
payment_method_code - String! (BETA) The payment method code associated with the token.
public_hash - String! (BETA) The public hash of the token.
type - PaymentTokenTypeEnum! (BETA) Specifies the payment token type.
Example
{
  "details": "xyz789",
  "payment_method_code": "abc123",
  "public_hash": "abc123",
  "type": "card"
}

PaymentTokenTypeEnum

Description

(BETA) The list of available payment token types.

Values
Enum Value Description

card

(BETA) phpcs:ignore Magento2.GraphQL.ValidArgumentName

account

(BETA) phpcs:ignore Magento2.GraphQL.ValidArgumentName
Example
"card"

PaypalExpressInput

Description

(BETA) Contains required input for Express Checkout and Payments Standard payments.

Fields
Input Field Description
payer_id - String!

(BETA) The unique ID of the PayPal user.

token - String!

(BETA) The token returned by the createPaypalExpressToken mutation.

Example
{
  "payer_id": "xyz789",
  "token": "xyz789"
}

PaypalExpressTokenInput

Description

(BETA) Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID that identifies the customer's cart.

code - String!

(BETA) The payment method code.

express_button - Boolean

(BETA) Indicates whether the buyer selected the quick checkout button. The default value is false.

urls - PaypalExpressUrlsInput!

(BETA) A set of relative URLs that PayPal uses in response to various actions during the authorization process.

use_paypal_credit - Boolean

(BETA) Indicates whether the buyer clicked the PayPal credit button. The default value is false.

Example
{
  "cart_id": "xyz789",
  "code": "abc123",
  "express_button": false,
  "urls": PaypalExpressUrlsInput,
  "use_paypal_credit": true
}

PaypalExpressTokenOutput

Description

(BETA) Contains the token returned by PayPal and a set of URLs that allow the buyer to authorize payment and adjust checkout details. Applies to Express Checkout and Payments Standard payment methods.

Fields
Field Name Description
paypal_urls - PaypalExpressUrlList (BETA) A set of URLs that allow the buyer to authorize payment and adjust checkout details.
token - String (BETA) The token returned by PayPal.
Example
{
  "paypal_urls": PaypalExpressUrlList,
  "token": "abc123"
}

PaypalExpressUrlList

Description

(BETA) Contains a set of URLs that allow the buyer to authorize payment and adjust checkout details for Express Checkout and Payments Standard transactions.

Fields
Field Name Description
edit - String (BETA) The PayPal URL that allows the buyer to edit their checkout details.
start - String (BETA) The URL to the PayPal login page.
Example
{
  "edit": "xyz789",
  "start": "xyz789"
}

PaypalExpressUrlsInput

Description

(BETA) Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Express Checkout and Payments Standard payment methods.

Fields
Input Field Description
cancel_url - String!

(BETA) The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.

pending_url - String

(BETA) The relative URL of the page that PayPal redirects to when the payment has been put on hold for additional review. This condition mostly applies to ACH transactions, and is not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success_pending.html, the relative URL is paypal/action/success_pending.html.

return_url - String!

(BETA) The relative URL of the final confirmation page that PayPal redirects to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.

success_url - String

(BETA) The relative URL of the order confirmation page that PayPal redirects to when the payment is successful and additional confirmation is not needed. Not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success.html, the relative URL is paypal/action/success.html.

Example
{
  "cancel_url": "abc123",
  "pending_url": "xyz789",
  "return_url": "xyz789",
  "success_url": "abc123"
}

PhysicalProductInterface

Description

(BETA) Contains attributes specific to tangible products.

Fields
Field Name Description
weight - Float (BETA) The weight of the item, in units defined by the store.
Possible Types
PhysicalProductInterface Types

SimpleProduct

BundleProduct

GiftCardProduct

GroupedProduct

ConfigurableProduct

Example
{"weight": 987.65}

PickupLocation

Description

(BETA) Defines Pickup Location information.

Fields
Field Name Description
city - String
contact_name - String
country_id - String
description - String
email - String
fax - String
latitude - Float
longitude - Float
name - String
phone - String
pickup_location_code - String
postcode - String
region - String
region_id - Int
street - String
Example
{
  "city": "abc123",
  "contact_name": "xyz789",
  "country_id": "xyz789",
  "description": "abc123",
  "email": "abc123",
  "fax": "abc123",
  "latitude": 987.65,
  "longitude": 987.65,
  "name": "xyz789",
  "phone": "xyz789",
  "pickup_location_code": "abc123",
  "postcode": "abc123",
  "region": "xyz789",
  "region_id": 987,
  "street": "abc123"
}

PickupLocationFilterInput

Description

(BETA) PickupLocationFilterInput defines the list of attributes and filters for the search.

Fields
Input Field Description
city - FilterTypeInput

(BETA) Filter by city.

country_id - FilterTypeInput

(BETA) Filter by country.

name - FilterTypeInput

(BETA) Filter by pickup location name.

pickup_location_code - FilterTypeInput

(BETA) Filter by pickup location code.

postcode - FilterTypeInput

(BETA) Filter by postcode.

region - FilterTypeInput

(BETA) Filter by region.

region_id - FilterTypeInput

(BETA) Filter by region id.

street - FilterTypeInput

(BETA) Filter by street.

Example
{
  "city": FilterTypeInput,
  "country_id": FilterTypeInput,
  "name": FilterTypeInput,
  "pickup_location_code": FilterTypeInput,
  "postcode": FilterTypeInput,
  "region": FilterTypeInput,
  "region_id": FilterTypeInput,
  "street": FilterTypeInput
}

PickupLocationSortInput

Description

(BETA) PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.

Fields
Input Field Description
city - SortEnum

(BETA) City where pickup location is placed.

contact_name - SortEnum

(BETA) Name of the contact person.

country_id - SortEnum

(BETA) Id of the country in two letters.

description - SortEnum

(BETA) Description of the pickup location.

distance - SortEnum

(BETA) Distance to the address, requested by distance filter. Applicable only with distance filter. If distance sort order is present, all other sort orders will be ignored.

email - SortEnum

(BETA) Contact email of the pickup location.

fax - SortEnum

(BETA) Contact fax of the pickup location.

latitude - SortEnum

(BETA) Geographic latitude where pickup location is placed.

longitude - SortEnum

(BETA) Geographic longitude where pickup location is placed.

name - SortEnum

(BETA) The pickup location name. Customer use this to identify the pickup location.

phone - SortEnum

(BETA) Contact phone number of the pickup location.

pickup_location_code - SortEnum

(BETA) A code assigned to pickup location to identify the source.

postcode - SortEnum

(BETA) Postcode where pickup location is placed.

region - SortEnum

(BETA) Name of the region.

region_id - SortEnum

(BETA) Id of the region.

street - SortEnum

(BETA) Street where pickup location is placed.

Example
{
  "city": "ASC",
  "contact_name": "ASC",
  "country_id": "ASC",
  "description": "ASC",
  "distance": "ASC",
  "email": "ASC",
  "fax": "ASC",
  "latitude": "ASC",
  "longitude": "ASC",
  "name": "ASC",
  "phone": "ASC",
  "pickup_location_code": "ASC",
  "postcode": "ASC",
  "region": "ASC",
  "region_id": "ASC",
  "street": "ASC"
}

PickupLocations

Description

(BETA) Top level object returned in a pickup locations search.

Fields
Field Name Description
items - [PickupLocation] (BETA) An array of pickup locations that match the specific search request.
page_info - SearchResultPageInfo (BETA) An object that includes the page_info and currentPage values specified in the query.
total_count - Int (BETA) The number of products returned.
Example
{
  "items": [PickupLocation],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

PlaceNegotiableQuoteOrderInput

Description

(BETA) Specifies the negotiable quote to convert to an order.

Fields
Input Field Description
quote_uid - ID!

(BETA) The unique ID of a NegotiableQuote object.

Example
{"quote_uid": "4"}

PlaceNegotiableQuoteOrderOutput

Description

(BETA) An output object that returns the generated order.

Fields
Field Name Description
order - Order! (BETA) Contains the generated order number.
Example
{"order": Order}

PlaceOrderForPurchaseOrderInput

Description

(BETA) Specifies the purchase order to convert to an order.

Fields
Input Field Description
purchase_order_uid - ID!

(BETA) The unique ID of a purchase order.

Example
{"purchase_order_uid": 4}

PlaceOrderForPurchaseOrderOutput

Description

(BETA) Contains the results of the request to place an order.

Fields
Field Name Description
order - CustomerOrder! (BETA) Placed order.
Example
{"order": CustomerOrder}

PlaceOrderInput

Description

(BETA) Specifies the quote to be converted to an order.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID of a Cart object.

Example
{"cart_id": "xyz789"}

PlaceOrderOutput

Description

(BETA) Contains the results of the request to place an order.

Fields
Field Name Description
order - Order! (BETA) The ID of the order.
Example
{"order": Order}

PlacePurchaseOrderInput

Description

(BETA) Specifies the quote to be converted to a purchase order.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID of a Cart object.

Example
{"cart_id": "abc123"}

PlacePurchaseOrderOutput

Description

(BETA) Contains the results of the request to place a purchase order.

Fields
Field Name Description
purchase_order - PurchaseOrder! (BETA) Placed purchase order.
Example
{"purchase_order": PurchaseOrder}

Price

Description

(BETA) Deprecated. Use ProductPrice instead. Defines the price of a product as well as any tax-related adjustments.

Fields
Field Name Description
adjustments - [PriceAdjustment] (BETA) An array that provides information about tax, weee, or weee_tax adjustments. Use ProductPrice instead.
amount - Money (BETA) The price of a product plus a three-letter currency code. Use ProductPrice instead.
Example
{
  "adjustments": [PriceAdjustment],
  "amount": Money
}

PriceAdjustment

Description

(BETA) Deprecated. Taxes will be included or excluded in the price. Defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.

Fields
Field Name Description
amount - Money (BETA) The amount of the price adjustment and its currency code.
code - PriceAdjustmentCodesEnum (BETA) Indicates whether the adjustment involves tax, weee, or weee_tax. PriceAdjustment is deprecated.
description - PriceAdjustmentDescriptionEnum (BETA) Indicates whether the entity described by the code attribute is included or excluded from the adjustment. PriceAdjustment is deprecated.
Example
{
  "amount": Money,
  "code": "TAX",
  "description": "INCLUDED"
}

PriceAdjustmentCodesEnum

Description

PriceAdjustment.code is deprecated.

Values
Enum Value Description

TAX

PriceAdjustmentCodesEnum is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog.

WEEE

WEEE code is deprecated. Use fixed_product_taxes.label instead.

WEEE_TAX

Use fixed_product_taxes instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog.
Example
"TAX"

PriceAdjustmentDescriptionEnum

Description

PriceAdjustmentDescriptionEnum is deprecated. States whether a price adjustment is included or excluded.

Values
Enum Value Description

INCLUDED

EXCLUDED

Example
"INCLUDED"

PriceRange

Description

(BETA) Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.

Fields
Field Name Description
maximum_price - ProductPrice (BETA) The highest possible price for the product.
minimum_price - ProductPrice! (BETA) The lowest possible price for the product.
Example
{
  "maximum_price": ProductPrice,
  "minimum_price": ProductPrice
}

PriceTypeEnum

Description

(BETA) Defines the price type.

Values
Enum Value Description

FIXED

PERCENT

DYNAMIC

Example
"FIXED"

PriceViewEnum

Description

(BETA) Defines whether a bundle product's price is displayed as the lowest possible value or as a range.

Values
Enum Value Description

PRICE_RANGE

AS_LOW_AS

Example
"PRICE_RANGE"

ProductAttribute

Description

(BETA) Contains a product attribute code and value.

Fields
Field Name Description
code - String! (BETA) The unique identifier for a product attribute code.
value - String! (BETA) The display value of the attribute.
Example
{
  "code": "xyz789",
  "value": "abc123"
}

ProductAttributeFilterInput

Description

(BETA) Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.

Fields
Input Field Description
activity - FilterEqualTypeInput

(BETA) Attribute label: Activity

category_gear - FilterEqualTypeInput

(BETA) Attribute label: Category Gear

category_id - FilterEqualTypeInput

(BETA) Deprecated: use category_uid to filter product by category ID.

category_uid - FilterEqualTypeInput

(BETA) Filter product by the unique ID for a CategoryInterface object.

climate - FilterEqualTypeInput

(BETA) Attribute label: Climate

collar - FilterEqualTypeInput

(BETA) Attribute label: Collar

color - FilterEqualTypeInput

(BETA) Attribute label: Color

description - FilterMatchTypeInput

(BETA) Attribute label: Description

eco_collection - FilterEqualTypeInput

(BETA) Attribute label: Eco Collection

erin_recommends - FilterEqualTypeInput

(BETA) Attribute label: Erin Recommends

features_bags - FilterEqualTypeInput

(BETA) Attribute label: Features

format - FilterEqualTypeInput

(BETA) Attribute label: Format

gender - FilterEqualTypeInput

(BETA) Attribute label: Gender

material - FilterEqualTypeInput

(BETA) Attribute label: Material

name - FilterMatchTypeInput

(BETA) Attribute label: Product Name

new - FilterEqualTypeInput

(BETA) Attribute label: New

pattern - FilterEqualTypeInput

(BETA) Attribute label: Pattern

performance_fabric - FilterEqualTypeInput

(BETA) Attribute label: Performance Fabric

price - FilterRangeTypeInput

(BETA) Attribute label: Price

purpose - FilterEqualTypeInput

(BETA) Attribute label: Purpose

sale - FilterEqualTypeInput

(BETA) Attribute label: Sale

short_description - FilterMatchTypeInput

(BETA) Attribute label: Short Description

size - FilterEqualTypeInput

(BETA) Attribute label: Size

sku - FilterEqualTypeInput

(BETA) Attribute label: SKU

sleeve - FilterEqualTypeInput

(BETA) Attribute label: Sleeve

strap_bags - FilterEqualTypeInput

(BETA) Attribute label: Strap/Handle

style_bags - FilterEqualTypeInput

(BETA) Attribute label: Style Bags

style_bottom - FilterEqualTypeInput

(BETA) Attribute label: Style Bottom

style_general - FilterEqualTypeInput

(BETA) Attribute label: Style General

url_key - FilterEqualTypeInput

(BETA) The part of the URL that identifies the product

Example
{
  "activity": FilterEqualTypeInput,
  "category_gear": FilterEqualTypeInput,
  "category_id": FilterEqualTypeInput,
  "category_uid": FilterEqualTypeInput,
  "climate": FilterEqualTypeInput,
  "collar": FilterEqualTypeInput,
  "color": FilterEqualTypeInput,
  "description": FilterMatchTypeInput,
  "eco_collection": FilterEqualTypeInput,
  "erin_recommends": FilterEqualTypeInput,
  "features_bags": FilterEqualTypeInput,
  "format": FilterEqualTypeInput,
  "gender": FilterEqualTypeInput,
  "material": FilterEqualTypeInput,
  "name": FilterMatchTypeInput,
  "new": FilterEqualTypeInput,
  "pattern": FilterEqualTypeInput,
  "performance_fabric": FilterEqualTypeInput,
  "price": FilterRangeTypeInput,
  "purpose": FilterEqualTypeInput,
  "sale": FilterEqualTypeInput,
  "short_description": FilterMatchTypeInput,
  "size": FilterEqualTypeInput,
  "sku": FilterEqualTypeInput,
  "sleeve": FilterEqualTypeInput,
  "strap_bags": FilterEqualTypeInput,
  "style_bags": FilterEqualTypeInput,
  "style_bottom": FilterEqualTypeInput,
  "style_general": FilterEqualTypeInput,
  "url_key": FilterEqualTypeInput
}

ProductAttributeSortInput

Description

(BETA) Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. It's possible to sort products using searchable attributes with enabled 'Use in Filter Options' option

Fields
Input Field Description
name - SortEnum

(BETA) Attribute label: Product Name

position - SortEnum

(BETA) Sort by the position assigned to each product.

price - SortEnum

(BETA) Attribute label: Price

relevance - SortEnum

(BETA) Sort by the search relevance score (default).

Example
{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"}

ProductDiscount

Description

(BETA) Contains the discount applied to a product price.

Fields
Field Name Description
amount_off - Float (BETA) The actual value of the discount.
percent_off - Float (BETA) The discount expressed a percentage.
Example
{"amount_off": 987.65, "percent_off": 123.45}

ProductFilterInput

Description

(BETA) ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.

Fields
Input Field Description
category_id - FilterTypeInput

(BETA) The category ID the product belongs to.

country_of_manufacture - FilterTypeInput

(BETA) The product's country of origin.

created_at - FilterTypeInput

(BETA) The timestamp indicating when the product was created.

custom_layout - FilterTypeInput

(BETA) The name of a custom layout.

custom_layout_update - FilterTypeInput

(BETA) XML code that is applied as a layout update to the product page.

description - FilterTypeInput

(BETA) Detailed information about the product. The value can include simple HTML tags.

gift_message_available - FilterTypeInput

(BETA) Indicates whether a gift message is available.

has_options - FilterTypeInput

(BETA) Indicates whether additional attributes have been created for the product.

image - FilterTypeInput

(BETA) The relative path to the main image on the product page.

image_label - FilterTypeInput

(BETA) The label assigned to a product image.

is_returnable - FilterTypeInput

(BETA) Indicates whether the product can be returned.

manufacturer - FilterTypeInput

(BETA) A number representing the product's manufacturer.

max_price - FilterTypeInput

(BETA) The numeric maximal price of the product. Do not include the currency code.

meta_description - FilterTypeInput

(BETA) A brief overview of the product for search results listings, maximum 255 characters.

meta_keyword - FilterTypeInput

(BETA) A comma-separated list of keywords that are visible only to search engines.

meta_title - FilterTypeInput

(BETA) A string that is displayed in the title bar and tab of the browser and in search results lists.

min_price - FilterTypeInput

(BETA) The numeric minimal price of the product. Do not include the currency code.

name - FilterTypeInput

(BETA) The product name. Customers use this name to identify the product.

news_from_date - FilterTypeInput

(BETA) The beginning date for new product listings, and determines if the product is featured as a new product.

news_to_date - FilterTypeInput

(BETA) The end date for new product listings.

options_container - FilterTypeInput

(BETA) If the product has multiple options, determines where they appear on the product page.

or - ProductFilterInput

(BETA) The keyword required to perform a logical OR comparison.

price - FilterTypeInput

(BETA) The price of an item.

required_options - FilterTypeInput

(BETA) Indicates whether the product has required options.

short_description - FilterTypeInput

(BETA) A short description of the product. Its use depends on the theme.

sku - FilterTypeInput

(BETA) A number or code assigned to a product to identify the product, options, price, and manufacturer.

small_image - FilterTypeInput

(BETA) The relative path to the small image, which is used on catalog pages.

small_image_label - FilterTypeInput

(BETA) The label assigned to a product's small image.

special_from_date - FilterTypeInput

(BETA) The beginning date that a product has a special price.

special_price - FilterTypeInput

(BETA) The discounted price of the product. Do not include the currency code.

special_to_date - FilterTypeInput

(BETA) The end date that a product has a special price.

swatch_image - FilterTypeInput

(BETA) The file name of a swatch image.

thumbnail - FilterTypeInput

(BETA) The relative path to the product's thumbnail image.

thumbnail_label - FilterTypeInput

(BETA) The label assigned to a product's thumbnail image.

tier_price - FilterTypeInput

(BETA) The price when tier pricing is in effect and the items purchased threshold has been reached.

updated_at - FilterTypeInput

(BETA) The timestamp indicating when the product was updated.

url_key - FilterTypeInput

(BETA) The part of the URL that identifies the product

url_path - FilterTypeInput
weight - FilterTypeInput

(BETA) The weight of the item, in units defined by the store.

Example
{
  "category_id": FilterTypeInput,
  "country_of_manufacture": FilterTypeInput,
  "created_at": FilterTypeInput,
  "custom_layout": FilterTypeInput,
  "custom_layout_update": FilterTypeInput,
  "description": FilterTypeInput,
  "gift_message_available": FilterTypeInput,
  "has_options": FilterTypeInput,
  "image": FilterTypeInput,
  "image_label": FilterTypeInput,
  "is_returnable": FilterTypeInput,
  "manufacturer": FilterTypeInput,
  "max_price": FilterTypeInput,
  "meta_description": FilterTypeInput,
  "meta_keyword": FilterTypeInput,
  "meta_title": FilterTypeInput,
  "min_price": FilterTypeInput,
  "name": FilterTypeInput,
  "news_from_date": FilterTypeInput,
  "news_to_date": FilterTypeInput,
  "options_container": FilterTypeInput,
  "or": ProductFilterInput,
  "price": FilterTypeInput,
  "required_options": FilterTypeInput,
  "short_description": FilterTypeInput,
  "sku": FilterTypeInput,
  "small_image": FilterTypeInput,
  "small_image_label": FilterTypeInput,
  "special_from_date": FilterTypeInput,
  "special_price": FilterTypeInput,
  "special_to_date": FilterTypeInput,
  "swatch_image": FilterTypeInput,
  "thumbnail": FilterTypeInput,
  "thumbnail_label": FilterTypeInput,
  "tier_price": FilterTypeInput,
  "updated_at": FilterTypeInput,
  "url_key": FilterTypeInput,
  "url_path": FilterTypeInput,
  "weight": FilterTypeInput
}

ProductImage

Description

(BETA) Contains product image information, including the image URL and label.

Fields
Field Name Description
disabled - Boolean (BETA) Indicates whether the image is hidden from view.
label - String (BETA) The label of the product image or video.
position - Int (BETA) The media item's position after it has been sorted.
url - String (BETA) The URL of the product image or video.
Example
{
  "disabled": true,
  "label": "abc123",
  "position": 987,
  "url": "xyz789"
}

ProductInfoInput

Description

(BETA) Product Information used for Pickup Locations search.

Fields
Input Field Description
sku - String!

(BETA) Product SKU.

Example
{"sku": "xyz789"}

ProductInterface

Description

(BETA) Contains fields that are common to all types of products.

Fields
Field Name Description
activity - String Use the custom_attributes field instead.
attribute_set_id - Int (BETA) The attribute set assigned to the product. The field should not be used on the storefront.
canonical_url - String (BETA) The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] (BETA) The categories assigned to a product.
category_gear - String Use the custom_attributes field instead.
climate - String Use the custom_attributes field instead.
collar - String Use the custom_attributes field instead.
color - Int Use the custom_attributes field instead.
country_of_manufacture - String (BETA) The product's country of origin.
created_at - String (BETA) Timestamp indicating when the product was created. The field should not be used on the storefront.
crosssell_products - [ProductInterface] (BETA) An array of cross-sell products.
description - ComplexTextValue (BETA) Detailed information about the product. The value can include simple HTML tags.
eco_collection - Int Use the custom_attributes field instead.
erin_recommends - Int Use the custom_attributes field instead.
features_bags - String Use the custom_attributes field instead.
format - Int Use the custom_attributes field instead.
gender - String Use the custom_attributes field instead.
gift_message_available - String (BETA) Indicates whether a gift message is available.
id - Int (BETA) The ID number assigned to the product. Use the uid field instead.
image - ProductImage (BETA) The relative path to the main image on the product page.
is_returnable - String (BETA) Indicates whether the product can be returned.
manufacturer - Int (BETA) A number representing the product's manufacturer. Use the custom_attributes field instead.
material - String Use the custom_attributes field instead.
media_gallery - [MediaGalleryInterface] (BETA) An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] (BETA) An array of MediaGalleryEntry objects. Use media_gallery instead.
meta_description - String (BETA) A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String (BETA) A comma-separated list of keywords that are visible only to search engines.
meta_title - String (BETA) A string that is displayed in the title bar and tab of the browser and in search results lists.
name - String (BETA) The product name. Customers use this name to identify the product.
new - Int Use the custom_attributes field instead.
new_from_date - String (BETA) The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String (BETA) The end date for new product listings.
only_x_left_in_stock - Float (BETA) Product stock only x left count
options_container - String (BETA) If the product has multiple options, determines where they appear on the product page.
pattern - String Use the custom_attributes field instead.
performance_fabric - Int Use the custom_attributes field instead.
price - ProductPrices (BETA) Indicates the price of an item. Use price_range for product price information.
price_range - PriceRange! (BETA) The range of prices for the product
price_tiers - [TierPrice] (BETA) An array of TierPrice objects.
product_links - [ProductLinksInterface] (BETA) An array of ProductLinks objects.
purpose - Int Use the custom_attributes field instead.
rating_summary - Float! (BETA) The average of all the ratings given to the product.
related_products - [ProductInterface] (BETA) An array of related products.
review_count - Int! (BETA) The total count of all the reviews given to the product.
reviews - ProductReviews! (BETA) The list of products reviews.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default is 20.

currentPage - Int

(BETA) The page of results to return. The default is 1.

sale - Int Use the custom_attributes field instead.
short_description - ComplexTextValue (BETA) A short description of the product. Its use depends on the theme.
size - Int Use the custom_attributes field instead.
sku - String (BETA) A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String Use the custom_attributes field instead.
small_image - ProductImage (BETA) The relative path to the small image, which is used on catalog pages.
special_from_date - String (BETA) The beginning date that a product has a special price. The field should not be used on the storefront.
special_price - Float (BETA) The discounted price of the product.
special_to_date - String (BETA) The end date for a product with a special price.
staged - Boolean! (BETA) Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus (BETA) Stock status of the product
strap_bags - String Use the custom_attributes field instead.
style_bags - String Use the custom_attributes field instead.
style_bottom - String Use the custom_attributes field instead.
style_general - String Use the custom_attributes field instead.
swatch_image - String (BETA) The file name of a swatch image.
thumbnail - ProductImage (BETA) The relative path to the product's thumbnail image.
tier_price - Float (BETA) The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information.
tier_prices - [ProductTierPrices] (BETA) An array of ProductTierPrices objects. Use price_tiers for product tier price information.
type_id - String (BETA) One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead.
uid - ID! (BETA) The unique ID for a ProductInterface object.
updated_at - String (BETA) Timestamp indicating when the product was updated. The field should not be used on the storefront.
upsell_products - [ProductInterface] (BETA) An array of up-sell products.
url_key - String (BETA) The part of the URL that identifies the product
url_path - String Use product's canonical_url or url rewrites instead
url_rewrites - [UrlRewrite] (BETA) URL rewrites list
url_suffix - String (BETA) The part of the product URL that is appended after the url key
websites - [Website] (BETA) An array of websites in which the product is available. The field should not be used on the storefront.
Example
{
  "activity": "abc123",
  "attribute_set_id": 123,
  "canonical_url": "abc123",
  "categories": [CategoryInterface],
  "category_gear": "xyz789",
  "climate": "abc123",
  "collar": "abc123",
  "color": 123,
  "country_of_manufacture": "xyz789",
  "created_at": "abc123",
  "crosssell_products": [ProductInterface],
  "description": ComplexTextValue,
  "eco_collection": 987,
  "erin_recommends": 123,
  "features_bags": "xyz789",
  "format": 123,
  "gender": "xyz789",
  "gift_message_available": "abc123",
  "id": 987,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "manufacturer": 987,
  "material": "abc123",
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "abc123",
  "meta_keyword": "abc123",
  "meta_title": "xyz789",
  "name": "xyz789",
  "new": 123,
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 987.65,
  "options_container": "abc123",
  "pattern": "abc123",
  "performance_fabric": 987,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 123,
  "rating_summary": 123.45,
  "related_products": [ProductInterface],
  "review_count": 987,
  "reviews": ProductReviews,
  "sale": 987,
  "short_description": ComplexTextValue,
  "size": 987,
  "sku": "xyz789",
  "sleeve": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "abc123",
  "staged": false,
  "stock_status": "IN_STOCK",
  "strap_bags": "abc123",
  "style_bags": "xyz789",
  "style_bottom": "xyz789",
  "style_general": "xyz789",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type_id": "xyz789",
  "uid": "4",
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website]
}

ProductLinksInterface

Description

(BETA) Contains information about linked products, including the link type and product type of each item.

Fields
Field Name Description
link_type - String (BETA) One of related, associated, upsell, or crosssell.
linked_product_sku - String (BETA) The SKU of the linked product.
linked_product_type - String (BETA) The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).
position - Int (BETA) The position within the list of product links.
sku - String (BETA) The identifier of the linked product.
Possible Types
ProductLinksInterface Types

ProductLinks

Example
{
  "link_type": "xyz789",
  "linked_product_sku": "abc123",
  "linked_product_type": "abc123",
  "position": 123,
  "sku": "xyz789"
}

ProductMediaGalleryEntriesContent

Description

(BETA) Contains an image in base64 format and basic information about the image.

Fields
Field Name Description
base64_encoded_data - String (BETA) The image in base64 format.
name - String (BETA) The file name of the image.
type - String (BETA) The MIME type of the file, such as image/png.
Example
{
  "base64_encoded_data": "abc123",
  "name": "xyz789",
  "type": "abc123"
}

ProductMediaGalleryEntriesVideoContent

Description

(BETA) Contains a link to a video file and basic information about the video.

Fields
Field Name Description
media_type - String (BETA) Must be external-video.
video_description - String (BETA) A description of the video.
video_metadata - String (BETA) Optional data about the video.
video_provider - String (BETA) Describes the video source.
video_title - String (BETA) The title of the video.
video_url - String (BETA) The URL to the video.
Example
{
  "media_type": "xyz789",
  "video_description": "xyz789",
  "video_metadata": "abc123",
  "video_provider": "abc123",
  "video_title": "xyz789",
  "video_url": "xyz789"
}

ProductPrice

Description

(BETA) Represents a product price.

Fields
Field Name Description
discount - ProductDiscount (BETA) The price discount. Represents the difference between the regular and final price.
final_price - Money! (BETA) The final price of the product after applying discounts.
fixed_product_taxes - [FixedProductTax] (BETA) An array of the multiple Fixed Product Taxes that can be applied to a product price.
regular_price - Money! (BETA) The regular price of the product.
Example
{
  "discount": ProductDiscount,
  "final_price": Money,
  "fixed_product_taxes": [FixedProductTax],
  "regular_price": Money
}

ProductPrices

Description

(BETA) Deprecated. Use PriceRange instead. Contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.

Fields
Field Name Description
maximalPrice - Price (BETA) The highest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the to value. Use PriceRange.maximum_price instead.
minimalPrice - Price (BETA) The lowest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the from value. Use PriceRange.minimum_price instead.
regularPrice - Price (BETA) The base price of a product. Use regular_price from PriceRange.minimum_price or PriceRange.maximum_price instead.
Example
{
  "maximalPrice": Price,
  "minimalPrice": Price,
  "regularPrice": Price
}

ProductReview

Description

(BETA) Contains details of a product review.

Fields
Field Name Description
average_rating - Float! (BETA) The average of all ratings for this product.
created_at - String! (BETA) The date the review was created.
nickname - String! (BETA) The customer's nickname. Defaults to the customer name, if logged in.
product - ProductInterface! (BETA) The reviewed product.
ratings_breakdown - [ProductReviewRating]! (BETA) An array of ratings by rating category, such as quality, price, and value.
summary - String! (BETA) The summary (title) of the review.
text - String! (BETA) The review text.
Example
{
  "average_rating": 123.45,
  "created_at": "abc123",
  "nickname": "xyz789",
  "product": ProductInterface,
  "ratings_breakdown": [ProductReviewRating],
  "summary": "abc123",
  "text": "xyz789"
}

ProductReviewRating

Description

(BETA) Contains data about a single aspect of a product review.

Fields
Field Name Description
name - String! (BETA) The label assigned to an aspect of a product that is being rated, such as quality or price.
value - String! (BETA) The rating value given by customer. By default, possible values range from 1 to 5.
Example
{
  "name": "abc123",
  "value": "xyz789"
}

ProductReviewRatingInput

Description

(BETA) Contains the reviewer's rating for a single aspect of a review.

Fields
Input Field Description
id - String!

(BETA) An encoded rating ID.

value_id - String!

(BETA) An encoded rating value ID.

Example
{
  "id": "xyz789",
  "value_id": "xyz789"
}

ProductReviewRatingMetadata

Description

(BETA) Contains details about a single aspect of a product review.

Fields
Field Name Description
id - String! (BETA) An encoded rating ID.
name - String! (BETA) The label assigned to an aspect of a product that is being rated, such as quality or price.
values - [ProductReviewRatingValueMetadata]! (BETA) List of product review ratings sorted by position.
Example
{
  "id": "abc123",
  "name": "xyz789",
  "values": [ProductReviewRatingValueMetadata]
}

ProductReviewRatingValueMetadata

Description

(BETA) Contains details about a single value in a product review.

Fields
Field Name Description
value - String! (BETA) A ratings scale, such as the number of stars awarded.
value_id - String! (BETA) An encoded rating value ID.
Example
{
  "value": "abc123",
  "value_id": "abc123"
}

ProductReviewRatingsMetadata

Description

(BETA) Contains an array of metadata about each aspect of a product review.

Fields
Field Name Description
items - [ProductReviewRatingMetadata]! (BETA) An array of product reviews sorted by position.
Example
{"items": [ProductReviewRatingMetadata]}

ProductReviews

Description

(BETA) Contains an array of product reviews.

Fields
Field Name Description
items - [ProductReview]! (BETA) An array of product reviews.
page_info - SearchResultPageInfo! (BETA) Metadata for pagination rendering.
Example
{
  "items": [ProductReview],
  "page_info": SearchResultPageInfo
}

ProductStockStatus

Description

(BETA) This enumeration states whether a product stock status is in stock or out of stock

Values
Enum Value Description

IN_STOCK

OUT_OF_STOCK

Example
"IN_STOCK"

ProductTierPrices

Description

(BETA) Deprecated. Use TierPrice instead. Defines a tier price, which is a quantity discount offered to a specific customer group.

Fields
Field Name Description
customer_group_id - String (BETA) The ID of the customer group. Not relevant for the storefront.
percentage_value - Float (BETA) The percentage discount of the item. Use TierPrice.discount instead.
qty - Float (BETA) The number of items that must be purchased to qualify for tier pricing. Use TierPrice.quantity instead.
value - Float (BETA) The price of the fixed price item. Use TierPrice.final_price instead.
website_id - Float (BETA) The ID assigned to the website. Not relevant for the storefront.
Example
{
  "customer_group_id": "xyz789",
  "percentage_value": 987.65,
  "qty": 987.65,
  "value": 987.65,
  "website_id": 123.45
}

ProductVideo

Description

(BETA) Contains information about a product video.

Fields
Field Name Description
disabled - Boolean (BETA) Indicates whether the image is hidden from view.
label - String (BETA) The label of the product image or video.
position - Int (BETA) The media item's position after it has been sorted.
url - String (BETA) The URL of the product image or video.
video_content - ProductMediaGalleryEntriesVideoContent (BETA) Contains a ProductMediaGalleryEntriesVideoContent object.
Example
{
  "disabled": true,
  "label": "xyz789",
  "position": 123,
  "url": "xyz789",
  "video_content": ProductMediaGalleryEntriesVideoContent
}

Products

Description

(BETA) Contains the results of a products query.

Fields
Field Name Description
aggregations - [Aggregation] (BETA) A bucket that contains the attribute code and label for each filterable option.
Arguments
filters - [LayerFilter] (BETA) Layered navigation filters array. Use aggregations instead.
items - [ProductInterface] (BETA) An array of products that match the specified search criteria.
page_info - SearchResultPageInfo (BETA) An object that includes the page_info and currentPage values specified in the query.
sort_fields - SortFields (BETA) An object that includes the default sort field and all available sort fields.
suggestions - [SearchSuggestion] (BETA) An array of search suggestions for case when search query have no results.
total_count - Int (BETA) The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.
Example
{
  "aggregations": [Aggregation],
  "filters": [LayerFilter],
  "items": [ProductInterface],
  "page_info": SearchResultPageInfo,
  "sort_fields": SortFields,
  "suggestions": [SearchSuggestion],
  "total_count": 987
}

PurchaseOrder

Description

(BETA) Contains details about a purchase order.

Fields
Field Name Description
approval_flow - [PurchaseOrderRuleApprovalFlow]! (BETA) The approval flows for each applied rules.
available_actions - [PurchaseOrderAction]! (BETA) Purchase order actions available to the customer. Can be used to display action buttons on the client.
comments - [PurchaseOrderComment]! (BETA) The set of comments applied to the purchase order.
created_at - String! (BETA) The date the purchase order was created.
created_by - Customer (BETA) The company user who created the purchase order.
history_log - [PurchaseOrderHistoryItem]! (BETA) The log of the events related to the purchase order.
number - String! (BETA) The purchase order number.
order - CustomerOrder (BETA) The reference to the order placed based on the purchase order.
quote - Cart (BETA) The quote related to the purchase order.
status - PurchaseOrderStatus! (BETA) The current status of the purchase order.
uid - ID! (BETA) A unique identifier for the purchase order.
updated_at - String! (BETA) The date the purchase order was last updated.
Example
{
  "approval_flow": [PurchaseOrderRuleApprovalFlow],
  "available_actions": ["REJECT"],
  "comments": [PurchaseOrderComment],
  "created_at": "abc123",
  "created_by": Customer,
  "history_log": [PurchaseOrderHistoryItem],
  "number": "abc123",
  "order": CustomerOrder,
  "quote": Cart,
  "status": "PENDING",
  "uid": 4,
  "updated_at": "xyz789"
}

PurchaseOrderAction

Values
Enum Value Description

REJECT

CANCEL

VALIDATE

APPROVE

PLACE_ORDER

Example
"REJECT"

PurchaseOrderActionError

Description

(BETA) Contains details about a failed action.

Fields
Field Name Description
message - String! (BETA) The returned error message.
type - PurchaseOrderErrorType! (BETA) The error type.
Example
{"message": "abc123", "type": "NOT_FOUND"}

PurchaseOrderApprovalFlowEvent

Description

(BETA) Contains details about a single event in the approval flow of the purchase order.

Fields
Field Name Description
message - String (BETA) A formatted message.
name - String (BETA) The approver name.
role - String (BETA) The approver role.
status - PurchaseOrderApprovalFlowItemStatus (BETA) The status related to the event.
updated_at - String (BETA) The date and time the event was updated.
Example
{
  "message": "abc123",
  "name": "xyz789",
  "role": "xyz789",
  "status": "PENDING",
  "updated_at": "abc123"
}

PurchaseOrderApprovalFlowItemStatus

Values
Enum Value Description

PENDING

APPROVED

REJECTED

Example
"PENDING"

PurchaseOrderApprovalRule

Description

(BETA) Contains details about a purchase order approval rule.

Fields
Field Name Description
applies_to_roles - [CompanyRole]! (BETA) The name of the user(s) affected by the the purchase order approval rule.
approver_roles - [CompanyRole]! (BETA) The name of the user who needs to approve purchase orders that trigger the approval rule.
condition - PurchaseOrderApprovalRuleConditionInterface (BETA) Condition which triggers the approval rule.
created_at - String! (BETA) The date the purchase order rule was created.
created_by - String! (BETA) The name of the user who created the purchase order approval rule.
description - String (BETA) Description of the purchase order approval rule.
name - String! (BETA) The name of the purchase order approval rule.
status - PurchaseOrderApprovalRuleStatus! (BETA) The status of the purchase order approval rule.
uid - ID! (BETA) The unique identifier for the purchase order approval rule.
updated_at - String! (BETA) The date the purchase order rule was last updated.
Example
{
  "applies_to_roles": [CompanyRole],
  "approver_roles": [CompanyRole],
  "condition": PurchaseOrderApprovalRuleConditionInterface,
  "created_at": "abc123",
  "created_by": "xyz789",
  "description": "abc123",
  "name": "xyz789",
  "status": "ENABLED",
  "uid": "4",
  "updated_at": "abc123"
}

PurchaseOrderApprovalRuleConditionAmount

Description

(BETA) Contains approval rule condition details, including the amount to be evaluated.

Fields
Field Name Description
amount - Money! (BETA) The amount to be be used for evaluation of the approval rule condition.
attribute - PurchaseOrderApprovalRuleType (BETA) The type of purchase order approval rule.
operator - PurchaseOrderApprovalRuleConditionOperator (BETA) The operator to be used for evaluating the approval rule condition.
Example
{
  "amount": Money,
  "attribute": "GRAND_TOTAL",
  "operator": "MORE_THAN"
}

PurchaseOrderApprovalRuleConditionInterface

Description

(BETA) Purchase order rule condition details.

Fields
Field Name Description
attribute - PurchaseOrderApprovalRuleType (BETA) The type of purchase order approval rule.
operator - PurchaseOrderApprovalRuleConditionOperator (BETA) The operator to be used for evaluating the approval rule condition.
Possible Types
PurchaseOrderApprovalRuleConditionInterface Types

PurchaseOrderApprovalRuleConditionAmount

PurchaseOrderApprovalRuleConditionQuantity

Example
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"}

PurchaseOrderApprovalRuleConditionOperator

Values
Enum Value Description

MORE_THAN

LESS_THAN

MORE_THAN_OR_EQUAL_TO

LESS_THAN_OR_EQUAL_TO

Example
"MORE_THAN"

PurchaseOrderApprovalRuleConditionQuantity

Description

(BETA) Contains approval rule condition details, including the quantity to be evaluated.

Fields
Field Name Description
attribute - PurchaseOrderApprovalRuleType (BETA) The type of purchase order approval rule.
operator - PurchaseOrderApprovalRuleConditionOperator (BETA) The operator to be used for evaluating the approval rule condition.
quantity - Int (BETA) The quantity to be used for evaluation of the approval rule condition.
Example
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123}

PurchaseOrderApprovalRuleInput

Description

(BETA) Defines a new purchase order approval rule.

Fields
Input Field Description
applies_to - [ID]!

(BETA) A list of company user role IDs to which this purchase order approval rule should be applied. When an empty array is provided, the rule is applied to all user roles in the system, including those created in the future.

approvers - [ID]!

(BETA) A list of B2B user roles that can approve this purchase order approval rule.

condition - CreatePurchaseOrderApprovalRuleConditionInput!

(BETA) The condition of the purchase order approval rule.

description - String

(BETA) A summary of the purpose of the purchase order approval rule.

name - String!

(BETA) The purchase order approval rule name.

status - PurchaseOrderApprovalRuleStatus!

(BETA) The status of the purchase order approval rule.

Example
{
  "applies_to": ["4"],
  "approvers": ["4"],
  "condition": CreatePurchaseOrderApprovalRuleConditionInput,
  "description": "abc123",
  "name": "abc123",
  "status": "ENABLED"
}

PurchaseOrderApprovalRuleMetadata

Description

(BETA) Contains metadata that can be used to render rule edit forms.

Fields
Field Name Description
available_applies_to - [CompanyRole]! (BETA) A list of B2B user roles that the rule can be applied to.
available_condition_currencies - [AvailableCurrency]! (BETA) A list of currencies that can be used to create approval rules based on amounts, for example shipping cost rules.
available_requires_approval_from - [CompanyRole]! (BETA) A list of B2B user roles that can be specified as approvers for the approval rules.
Example
{
  "available_applies_to": [CompanyRole],
  "available_condition_currencies": [AvailableCurrency],
  "available_requires_approval_from": [CompanyRole]
}

PurchaseOrderApprovalRuleStatus

Values
Enum Value Description

ENABLED

DISABLED

Example
"ENABLED"

PurchaseOrderApprovalRuleType

Values
Enum Value Description

GRAND_TOTAL

SHIPPING_INCL_TAX

NUMBER_OF_SKUS

Example
"GRAND_TOTAL"

PurchaseOrderApprovalRules

Description

(BETA) Contains the approval rules that the customer can see.

Fields
Field Name Description
items - [PurchaseOrderApprovalRule]! (BETA) A list of purchase order approval rules visible to the customer.
page_info - SearchResultPageInfo (BETA) Result pagination details.
total_count - Int (BETA) The total number of purchase order approval rules visible to the customer.
Example
{
  "items": [PurchaseOrderApprovalRule],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

PurchaseOrderComment

Description

(BETA) Contains details about a comment.

Fields
Field Name Description
author - Customer (BETA) The user who left the comment.
created_at - String! (BETA) The date and time when the comment was created.
text - String! (BETA) The text of the comment.
uid - ID! (BETA) A unique identifier of the comment.
Example
{
  "author": Customer,
  "created_at": "abc123",
  "text": "abc123",
  "uid": 4
}

PurchaseOrderErrorType

Values
Enum Value Description

NOT_FOUND

OPERATION_NOT_APPLICABLE

COULD_NOT_SAVE

NOT_VALID_DATA

UNDEFINED

Example
"NOT_FOUND"

PurchaseOrderHistoryItem

Description

(BETA) Contains details about a status change.

Fields
Field Name Description
activity - String! (BETA) The activity type of the event.
created_at - String! (BETA) The date and time when the event happened.
message - String! (BETA) The message representation of the event.
uid - ID! (BETA) A unique identifier of the purchase order history item.
Example
{
  "activity": "xyz789",
  "created_at": "xyz789",
  "message": "abc123",
  "uid": "4"
}

PurchaseOrderRuleApprovalFlow

Description

(BETA) Contains details about approval roles applied to the purchase order and status changes.

Fields
Field Name Description
events - [PurchaseOrderApprovalFlowEvent]! (BETA) The approval flow event related to the rule.
rule_name - String! (BETA) The name of the applied rule.
Example
{
  "events": [PurchaseOrderApprovalFlowEvent],
  "rule_name": "xyz789"
}

PurchaseOrderStatus

Values
Enum Value Description

PENDING

APPROVAL_REQUIRED

APPROVED

ORDER_IN_PROGRESS

ORDER_PLACED

ORDER_FAILED

REJECTED

CANCELED

APPROVED_PENDING_PAYMENT

Example
"PENDING"

PurchaseOrders

Description

(BETA) Contains a list of purchase orders.

Fields
Field Name Description
items - [PurchaseOrder]! (BETA) Purchase orders matching the search criteria.
page_info - SearchResultPageInfo (BETA) Page information of search result's current page.
total_count - Int (BETA) Total number of purchase orders found matching the search criteria.
Example
{
  "items": [PurchaseOrder],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

PurchaseOrdersActionInput

Description

(BETA) Defines which purchase orders to act on.

Fields
Input Field Description
purchase_order_uids - [ID]!

(BETA) An array of of purchase order UIDs.

Example
{"purchase_order_uids": [4]}

PurchaseOrdersActionOutput

Description

(BETA) Returns a list of updated purchase orders and any error messages.

Fields
Field Name Description
errors - [PurchaseOrderActionError]! (BETA) An array of error messages encountered while performing the operation.
purchase_orders - [PurchaseOrder]! (BETA) A list of purchase orders.
Example
{
  "errors": [PurchaseOrderActionError],
  "purchase_orders": [PurchaseOrder]
}

PurchaseOrdersFilterInput

Description

(BETA) Defines the criteria to use to filter the list of purchase orders.

Fields
Input Field Description
company_purchase_orders - Boolean

(BETA) Include only purchase orders made by subordinate company users.

created_date - FilterRangeTypeInput

(BETA) Filter by the creation date of the purchase order.

require_my_approval - Boolean

(BETA) Include only purchase orders that are waiting for the customer’s approval.

status - PurchaseOrderStatus

(BETA) Filter by the status of the purchase order.

Example
{
  "company_purchase_orders": false,
  "created_date": FilterRangeTypeInput,
  "require_my_approval": true,
  "status": "PENDING"
}

Region

Fields
Field Name Description
code - String (BETA) The two-letter code for the region, such as TX for Texas.
id - Int (BETA) The unique ID for a Region object.
name - String (BETA) The name of the region, such as Texas.
Example
{
  "code": "xyz789",
  "id": 987,
  "name": "abc123"
}

RemoveCouponFromCartInput

Description

(BETA) Specifies the cart from which to remove a coupon.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID of a Cart object.

Example
{"cart_id": "xyz789"}

RemoveCouponFromCartOutput

Description

(BETA) Contains details about the cart after removing a coupon.

Fields
Field Name Description
cart - Cart (BETA) The cart after removing a coupon.
Example
{"cart": Cart}

RemoveGiftCardFromCartInput

Description

(BETA) Defines the input required to run the removeGiftCardFromCart mutation.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID that identifies the customer's cart.

gift_card_code - String!

(BETA) The gift card code to be removed to the cart.

Example
{
  "cart_id": "xyz789",
  "gift_card_code": "abc123"
}

RemoveGiftCardFromCartOutput

Description

(BETA) Defines the possible output for the removeGiftCardFromCart mutation.

Fields
Field Name Description
cart - Cart! (BETA) The contents of the specified shopping cart.
Example
{"cart": Cart}

RemoveGiftRegistryItemsOutput

Description

(BETA) Contains the results of a request to remove an item from a gift registry.

Fields
Field Name Description
gift_registry - GiftRegistry (BETA) The gift registry after removing items.
Example
{"gift_registry": GiftRegistry}

RemoveGiftRegistryOutput

Description

(BETA) Contains the results of a request to delete a gift registry.

Fields
Field Name Description
success - Boolean! (BETA) Indicates whether the gift registry was successfully deleted.
Example
{"success": false}

RemoveGiftRegistryRegistrantsOutput

Description

(BETA) Contains the results of a request to delete a registrant.

Fields
Field Name Description
gift_registry - GiftRegistry (BETA) The gift registry after deleting registrants.
Example
{"gift_registry": GiftRegistry}

RemoveItemFromCartInput

Description

(BETA) Specifies which items to remove from the cart.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID of a Cart object.

cart_item_id - Int

(BETA) Deprecated. Use cart_item_uid instead.

cart_item_uid - ID

(BETA) Required field. The unique ID for a CartItemInterface object.

Example
{
  "cart_id": "xyz789",
  "cart_item_id": 123,
  "cart_item_uid": 4
}

RemoveItemFromCartOutput

Description

(BETA) Contains details about the cart after removing an item.

Fields
Field Name Description
cart - Cart! (BETA) The cart after removing an item.
Example
{"cart": Cart}

RemoveNegotiableQuoteItemsInput

Description

(BETA) Defines the items to remove from the specified negotiable quote.

Fields
Input Field Description
quote_item_uids - [ID]!

(BETA) An array of IDs indicating which items to remove from the negotiable quote.

quote_uid - ID!

(BETA) The unique ID of a NegotiableQuote object.

Example
{"quote_item_uids": [4], "quote_uid": "4"}

RemoveNegotiableQuoteItemsOutput

Description

(BETA) Contains the negotiable quote.

Fields
Field Name Description
quote - NegotiableQuote (BETA) The negotiable quote after removing items.
Example
{"quote": NegotiableQuote}

RemoveProductsFromCompareListInput

Description

(BETA) Defines which products to remove from a compare list.

Fields
Input Field Description
products - [ID]!

(BETA) An array of product IDs to remove from the compare list.

uid - ID!

(BETA) The unique identifier of the compare list to modify.

Example
{"products": [4], "uid": 4}

RemoveProductsFromWishlistOutput

Description

(BETA) Contains the customer's wish list and any errors encountered.

Fields
Field Name Description
user_errors - [WishListUserInputError]! (BETA) An array of errors encountered while deleting products from a wish list.
wishlist - Wishlist! (BETA) Contains the wish list with after items were successfully deleted.
Example
{
  "user_errors": [WishListUserInputError],
  "wishlist": Wishlist
}

RemoveReturnTrackingInput

Description

(BETA) Defines the tracking information to delete.

Fields
Input Field Description
return_shipping_tracking_uid - ID!

(BETA) The unique ID for a ReturnShippingTracking object.

Example
{"return_shipping_tracking_uid": 4}

RemoveReturnTrackingOutput

Description

(BETA) Contains the response after deleting tracking information.

Fields
Field Name Description
return - Return (BETA) Contains details about the modified return.
Example
{"return": Return}

RemoveRewardPointsFromCartOutput

Description

(BETA) Contains the customer cart.

Fields
Field Name Description
cart - Cart! (BETA) The customer cart after reward points are removed.
Example
{"cart": Cart}

RemoveStoreCreditFromCartInput

Description

(BETA) Defines the input required to run the removeStoreCreditFromCart mutation.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID that identifies the customer's cart.

Example
{"cart_id": "xyz789"}

RemoveStoreCreditFromCartOutput

Description

(BETA) Defines the possible output for the removeStoreCreditFromCart mutation.

Fields
Field Name Description
cart - Cart! (BETA) The contents of the specified shopping cart.
Example
{"cart": Cart}

ReorderItemsOutput

Description

(BETA) Contains the cart and any errors after adding products.

Fields
Field Name Description
cart - Cart! (BETA) Detailed information about the customer's cart.
userInputErrors - [CheckoutUserInputError]! (BETA) An array of reordering errors.
Example
{
  "cart": Cart,
  "userInputErrors": [CheckoutUserInputError]
}

RequestNegotiableQuoteInput

Description

(BETA) Defines properties of a negotiable quote request.

Fields
Input Field Description
cart_id - ID!

(BETA) The cart ID of the buyer requesting a new negotiable quote.

comment - NegotiableQuoteCommentInput!

(BETA) Comments the buyer entered to describe the request.

quote_name - String!

(BETA) The name the buyer assigned to the negotiable quote request.

Example
{
  "cart_id": 4,
  "comment": NegotiableQuoteCommentInput,
  "quote_name": "xyz789"
}

RequestNegotiableQuoteOutput

Description

(BETA) Contains the NegotiableQuote object generated when a buyer requests a negotiable quote.

Fields
Field Name Description
quote - NegotiableQuote (BETA) Details about the negotiable quote.
Example
{"quote": NegotiableQuote}

RequestReturnInput

Description

(BETA) Contains information needed to start a return request.

Fields
Input Field Description
comment_text - String

(BETA) Text the buyer entered that describes the reason for the refund request.

contact_email - String

(BETA) The email address the buyer enters to receive notifications about the status of the return.

items - [RequestReturnItemInput]!

(BETA) An array of items to be returned.

order_uid - ID!

(BETA) The unique ID for a Order object.

Example
{
  "comment_text": "xyz789",
  "contact_email": "abc123",
  "items": [RequestReturnItemInput],
  "order_uid": 4
}

RequestReturnItemInput

Description

(BETA) Contains details about an item to be returned.

Fields
Input Field Description
entered_custom_attributes - [EnteredCustomAttributeInput]

(BETA) Details about a custom attribute that was entered.

order_item_uid - ID!

(BETA) The unique ID for a OrderItemInterface object.

quantity_to_return - Float!

(BETA) The quantity of the item to be returned.

selected_custom_attributes - [SelectedCustomAttributeInput]

(BETA) An array of selected custom option IDs associated with the item to be returned. For example, the IDs for the selected color and size of a configurable product.

Example
{
  "entered_custom_attributes": [
    EnteredCustomAttributeInput
  ],
  "order_item_uid": "4",
  "quantity_to_return": 123.45,
  "selected_custom_attributes": [
    SelectedCustomAttributeInput
  ]
}

RequestReturnOutput

Description

(BETA) Contains the response to a return request.

Fields
Field Name Description
return - Return (BETA) Details about a single return request.
returns - Returns (BETA) An array of return requests.
Arguments
pageSize - Int

(BETA) Specifies the maximum number of results to return at once. The default is 20.

currentPage - Int

(BETA) Specifies which page of results to return. The default is 1.

Example
{
  "return": Return,
  "returns": Returns
}

RequisitionList

Description

(BETA) Defines the contents of a requisition list.

Fields
Field Name Description
description - String (BETA) Optional text that describes the requisition list.
items - RequistionListItems (BETA) An array of products added to the requisition list.
Arguments
currentPage - Int

(BETA) The page of results to return. The default value is 1.

pageSize - Int

(BETA) The maximum number of results to return. The default value is 1.

items_count - Int! (BETA) The number of items in the list.
name - String! (BETA) The requisition list name.
uid - ID! (BETA) The unique requisition list ID.
updated_at - String (BETA) The time of the last modification of the requisition list.
Example
{
  "description": "abc123",
  "items": RequistionListItems,
  "items_count": 987,
  "name": "xyz789",
  "uid": 4,
  "updated_at": "xyz789"
}

RequisitionListFilterInput

Description

(BETA) Defines requisition list filters.

Fields
Input Field Description
name - FilterMatchTypeInput

(BETA) Filter by the display name of the requisition list.

uids - FilterEqualTypeInput

(BETA) Filter requisition lists by one or more requisition list IDs.

Example
{
  "name": FilterMatchTypeInput,
  "uids": FilterEqualTypeInput
}

RequisitionListItemInterface

Description

(BETA) The interface for requisition list items.

Fields
Field Name Description
customizable_options - [SelectedCustomizableOption]! (BETA) Selected custom options for an item in the requisition list.
product - ProductInterface! (BETA) Details about a requisition list item.
quantity - Float! (BETA) The amount added.
uid - ID! (BETA) The unique ID for the requisition list item.
Example
{
  "customizable_options": [SelectedCustomizableOption],
  "product": ProductInterface,
  "quantity": 987.65,
  "uid": "4"
}

RequisitionListItemsInput

Description

(BETA) Defines the items to add.

Fields
Input Field Description
entered_options - [EnteredOptionInput]

(BETA) Entered option IDs.

parent_sku - String

(BETA) For configurable products, the SKU of the parent product.

quantity - Float

(BETA) The quantity of the product to add.

selected_options - [String]

(BETA) Selected option IDs.

sku - String!

(BETA) The product SKU.

Example
{
  "entered_options": [EnteredOptionInput],
  "parent_sku": "abc123",
  "quantity": 123.45,
  "selected_options": ["xyz789"],
  "sku": "abc123"
}

RequisitionLists

Description

(BETA) Defines customer requisition lists.

Fields
Field Name Description
items - [RequisitionList] (BETA) An array of requisition lists.
page_info - SearchResultPageInfo (BETA) Pagination metadata.
total_count - Int (BETA) The number of returned requisition lists.
Example
{
  "items": [RequisitionList],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

RequistionListItems

Description

(BETA) Contains an array of items added to a requisition list.

Fields
Field Name Description
items - [RequisitionListItemInterface]! (BETA) An array of items in the requisition list.
page_info - SearchResultPageInfo (BETA) Pagination metadata.
total_pages - Int! (BETA) The number of pages returned.
Example
{
  "items": [RequisitionListItemInterface],
  "page_info": SearchResultPageInfo,
  "total_pages": 123
}

Return

Description

(BETA) Contains details about a return.

Fields
Field Name Description
available_shipping_carriers - [ReturnShippingCarrier] (BETA) A list of shipping carriers available for returns.
comments - [ReturnComment] (BETA) A list of comments posted for the return request.
created_at - String! (BETA) The date the return was requested.
customer - ReturnCustomer! (BETA) Data from the customer who created the return request.
items - [ReturnItem] (BETA) A list of items being returned.
number - String! (BETA) A human-readable return number.
order - CustomerOrder (BETA) The order associated with the return.
shipping - ReturnShipping (BETA) Shipping information for the return.
status - ReturnStatus (BETA) The status of the return request.
uid - ID! (BETA) The unique ID for a Return object.
Example
{
  "available_shipping_carriers": [ReturnShippingCarrier],
  "comments": [ReturnComment],
  "created_at": "abc123",
  "customer": ReturnCustomer,
  "items": [ReturnItem],
  "number": "abc123",
  "order": CustomerOrder,
  "shipping": ReturnShipping,
  "status": "PENDING",
  "uid": 4
}

ReturnComment

Description

(BETA) Contains details about a return comment.

Fields
Field Name Description
author_name - String! (BETA) The name or author who posted the comment.
created_at - String! (BETA) The date and time the comment was posted.
text - String! (BETA) The contents of the comment.
uid - ID! (BETA) The unique ID for a ReturnComment object.
Example
{
  "author_name": "abc123",
  "created_at": "xyz789",
  "text": "abc123",
  "uid": "4"
}

ReturnCustomAttribute

Description

(BETA) Contains details about a ReturnCustomerAttribute object.

Fields
Field Name Description
label - String! (BETA) A description of the attribute.
uid - ID! (BETA) The unique ID for a ReturnCustomAttribute object.
value - String! (BETA) A JSON-encoded value of the attribute.
Example
{
  "label": "xyz789",
  "uid": "4",
  "value": "abc123"
}

ReturnCustomer

Description

(BETA) The customer information for the return.

Fields
Field Name Description
email - String! (BETA) The email address of the customer.
firstname - String (BETA) The first name of the customer.
lastname - String (BETA) The last name of the customer.
Example
{
  "email": "xyz789",
  "firstname": "abc123",
  "lastname": "abc123"
}

ReturnItem

Description

(BETA) Contains details about a product being returned.

Fields
Field Name Description
custom_attributes - [ReturnCustomAttribute] (BETA) Return item custom attributes that are visible on the storefront.
order_item - OrderItemInterface! (BETA) Provides access to the product being returned, including information about selected and entered options.
quantity - Float! (BETA) The quantity of the item the merchant authorized to be returned.
request_quantity - Float! (BETA) The quantity of the item requested to be returned.
status - ReturnItemStatus! (BETA) The return status of the item.
uid - ID! (BETA) The unique ID for a ReturnItem object.
Example
{
  "custom_attributes": [ReturnCustomAttribute],
  "order_item": OrderItemInterface,
  "quantity": 123.45,
  "request_quantity": 987.65,
  "status": "PENDING",
  "uid": "4"
}

ReturnItemStatus

Values
Enum Value Description

PENDING

AUTHORIZED

RECEIVED

APPROVED

REJECTED

DENIED

Example
"PENDING"

ReturnShipping

Description

(BETA) Contains details about the return shipping address.

Fields
Field Name Description
address - ReturnShippingAddress (BETA) The merchant-defined return shipping address.
tracking - [ReturnShippingTracking] (BETA) The unique ID for a ReturnShippingTracking object. If a single UID is specified, the array contains a single tracking record. Otherwise, array contains all tracking information.
Arguments
uid - ID
Example
{
  "address": ReturnShippingAddress,
  "tracking": [ReturnShippingTracking]
}

ReturnShippingAddress

Description

(BETA) Contains details about the shipping address used for receiving returned items.

Fields
Field Name Description
city - String! (BETA) The city for product returns.
contact_name - String (BETA) The merchant's contact person.
country - Country! (BETA) An object that defines the country for product returns.
postcode - String! (BETA) The postal code for product returns.
region - Region! (BETA) An object that defines the state or province for product returns.
street - [String]! (BETA) The street address for product returns.
telephone - String (BETA) The telephone number for product returns.
Example
{
  "city": "xyz789",
  "contact_name": "xyz789",
  "country": Country,
  "postcode": "abc123",
  "region": Region,
  "street": ["xyz789"],
  "telephone": "abc123"
}

ReturnShippingCarrier

Description

(BETA) Contains details about the carrier on a return.

Fields
Field Name Description
label - String! (BETA) A description of the shipping carrier.
uid - ID! (BETA) The unique ID for a ReturnShippingCarrier object assigned to the shipping carrier.
Example
{
  "label": "xyz789",
  "uid": "4"
}

ReturnShippingTracking

Description

(BETA) Contains shipping and tracking details.

Fields
Field Name Description
carrier - ReturnShippingCarrier! (BETA) Contains details of a shipping carrier.
status - ReturnShippingTrackingStatus (BETA) Details about the status of a shipment.
tracking_number - String! (BETA) A tracking number assigned by the carrier.
uid - ID! (BETA) The unique ID for a ReturnShippingTracking object assigned to the tracking item.
Example
{
  "carrier": ReturnShippingCarrier,
  "status": ReturnShippingTrackingStatus,
  "tracking_number": "abc123",
  "uid": 4
}

ReturnShippingTrackingStatus

Description

(BETA) Contains the status of a shipment.

Fields
Field Name Description
text - String! (BETA) Text that describes the status.
type - ReturnShippingTrackingStatusType! (BETA) Indicates whether the status type is informational or an error.
Example
{"text": "abc123", "type": "INFORMATION"}

ReturnShippingTrackingStatusType

Values
Enum Value Description

INFORMATION

ERROR

Example
"INFORMATION"

ReturnStatus

Values
Enum Value Description

PENDING

AUTHORIZED

PARTIALLY_AUTHORIZED

RECEIVED

PARTIALLY_RECEIVED

APPROVED

PARTIALLY_APPROVED

REJECTED

PARTIALLY_REJECTED

DENIED

PROCESSED_AND_CLOSED

CLOSED

Example
"PENDING"

Returns

Description

(BETA) Contains a list of customer return requests.

Fields
Field Name Description
items - [Return] (BETA) A list of return requests.
page_info - SearchResultPageInfo (BETA) Pagination metadata.
total_count - Int (BETA) The total number of return requests.
Example
{
  "items": [Return],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

RevokeCustomerTokenOutput

Description

(BETA) Contains the result of a request to revoke a customer token.

Fields
Field Name Description
result - Boolean! (BETA) The result of a request to revoke a customer token.
Example
{"result": true}

RewardPoints

Description

(BETA) Contains details about a customer's reward points.

Fields
Field Name Description
balance - RewardPointsAmount (BETA) The current balance of reward points.
balance_history - [RewardPointsBalanceHistoryItem] (BETA) The balance history of reward points. If the ability for customers to view the balance history has been disabled in the Admin, this field will be set to null.
exchange_rates - RewardPointsExchangeRates (BETA) The current exchange rates for reward points.
subscription_status - RewardPointsSubscriptionStatus (BETA) The subscription status of emails related to reward points.
Example
{
  "balance": RewardPointsAmount,
  "balance_history": [RewardPointsBalanceHistoryItem],
  "exchange_rates": RewardPointsExchangeRates,
  "subscription_status": RewardPointsSubscriptionStatus
}

RewardPointsAmount

Fields
Field Name Description
money - Money! (BETA) The reward points amount in store currency.
points - Float! (BETA) The reward points amount in points.
Example
{"money": Money, "points": 123.45}

RewardPointsBalanceHistoryItem

Description

(BETA) Contain details about the reward points transaction.

Fields
Field Name Description
balance - RewardPointsAmount (BETA) The award points balance after the completion of the transaction.
change_reason - String! (BETA) The reason the balance changed.
date - String! (BETA) The date of the transaction.
points_change - Float! (BETA) The number of points added or deducted in the transaction.
Example
{
  "balance": RewardPointsAmount,
  "change_reason": "xyz789",
  "date": "xyz789",
  "points_change": 123.45
}

RewardPointsExchangeRates

Description

(BETA) Lists the reward points exchange rates. The values depend on the customer group.

Fields
Field Name Description
earning - RewardPointsRate (BETA) How many points are earned for a given amount spent.
redemption - RewardPointsRate (BETA) How many points must be redeemed to get a given amount of currency discount at the checkout.
Example
{
  "earning": RewardPointsRate,
  "redemption": RewardPointsRate
}

RewardPointsRate

Description

(BETA) Contains details about customer's reward points rate.

Fields
Field Name Description
currency_amount - Float! (BETA) The money value for the exchange rate. For earnings, this is the amount spent to earn the specified points. For redemption, this is the amount of money the number of points represents.
points - Float! (BETA) The number of points for an exchange rate. For earnings, this is the number of points earned. For redemption, this is the number of points needed for redemption.
Example
{"currency_amount": 987.65, "points": 123.45}

RewardPointsSubscriptionStatus

Description

(BETA) Indicates whether the customer subscribes to reward points emails.

Fields
Field Name Description
balance_updates - RewardPointsSubscriptionStatusesEnum! (BETA) Indicates whether the customer subscribes to 'Reward points balance updates' emails.
points_expiration_notifications - RewardPointsSubscriptionStatusesEnum! (BETA) Indicates whether the customer subscribes to 'Reward points expiration notifications' emails.
Example
{
  "balance_updates": "SUBSCRIBED",
  "points_expiration_notifications": "SUBSCRIBED"
}

RewardPointsSubscriptionStatusesEnum

Values
Enum Value Description

SUBSCRIBED

NOT_SUBSCRIBED

Example
"SUBSCRIBED"

RoutableInterface

Description

(BETA) Routable entities serve as the model for a rendered page.

Fields
Field Name Description
redirect_code - Int! (BETA) Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String (BETA) The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
type - UrlRewriteEntityTypeEnum (BETA) One of PRODUCT, CATEGORY, or CMS_PAGE.
Example
{
  "redirect_code": 123,
  "relative_url": "abc123",
  "type": "CMS_PAGE"
}

SalesCommentItem

Description

(BETA) Contains details about a comment.

Fields
Field Name Description
message - String! (BETA) The text of the message.
timestamp - String! (BETA) The timestamp of the comment.
Example
{
  "message": "abc123",
  "timestamp": "xyz789"
}

ScopeTypeEnum

Description

(BETA) This enumeration defines the scope type for customer orders.

Values
Enum Value Description

GLOBAL

WEBSITE

STORE

Example
"GLOBAL"

SearchResultPageInfo

Description

(BETA) Provides navigation for the query response.

Fields
Field Name Description
current_page - Int (BETA) The specific page to return.
page_size - Int (BETA) The maximum number of items to return per page of results.
total_pages - Int (BETA) The total number of pages in the response.
Example
{"current_page": 123, "page_size": 987, "total_pages": 123}

SearchSuggestion

Description

(BETA) A string that contains search suggestion

Fields
Field Name Description
search - String! (BETA) The search suggestion of existing product.
Example
{"search": "abc123"}

SelectedBundleOption

Description

(BETA) Contains details about a selected bundle option.

Fields
Field Name Description
id - Int! Use uid instead
label - String! (BETA) The display name of the selected bundle product option.
type - String! (BETA) The type of selected bundle product option.
uid - ID! (BETA) The unique ID for a SelectedBundleOption object
values - [SelectedBundleOptionValue]! (BETA) An array of selected bundle option values.
Example
{
  "id": 987,
  "label": "abc123",
  "type": "xyz789",
  "uid": "4",
  "values": [SelectedBundleOptionValue]
}

SelectedBundleOptionValue

Description

(BETA) Contains details about a value for a selected bundle option.

Fields
Field Name Description
id - Int! (BETA) Use uid instead
label - String! (BETA) The display name of the value for the selected bundle product option.
price - Float! (BETA) The price of the value for the selected bundle product option.
quantity - Float! (BETA) The quantity of the value for the selected bundle product option.
uid - ID! (BETA) The unique ID for a SelectedBundleOptionValue object
Example
{
  "id": 987,
  "label": "xyz789",
  "price": 123.45,
  "quantity": 123.45,
  "uid": 4
}

SelectedConfigurableOption

Description

(BETA) Contains details about a selected configurable option.

Fields
Field Name Description
configurable_product_option_uid - ID! (BETA) The unique ID for a ConfigurableProductOptions object.
configurable_product_option_value_uid - ID! (BETA) The unique ID for a ConfigurableProductOptionsValues object.
id - Int! Use SelectedConfigurableOption.configurable_product_option_uid instead.
option_label - String! (BETA) The display text for the option.
value_id - Int! Use SelectedConfigurableOption.configurable_product_option_value_uid instead.
value_label - String! (BETA) The display name of the selected configurable option.
Example
{
  "configurable_product_option_uid": "4",
  "configurable_product_option_value_uid": "4",
  "id": 123,
  "option_label": "xyz789",
  "value_id": 987,
  "value_label": "abc123"
}

SelectedCustomAttributeInput

Description

(BETA) Contains details about an attribute the buyer selected.

Fields
Input Field Description
attribute_code - String!

(BETA) A string that identifies the selected attribute.

value - ID!

(BETA) The unique ID for a CustomAttribute object of a selected custom attribute.

Example
{"attribute_code": "xyz789", "value": 4}

SelectedCustomizableOption

Description

(BETA) Identifies a customized product that has been placed in a cart.

Fields
Field Name Description
customizable_option_uid - ID! (BETA) The unique ID for a specific CustomizableOptionInterface object, such as a CustomizableFieldOption, CustomizableFileOption, or CustomizableAreaOption object.
id - Int! Use SelectedCustomizableOption.customizable_option_uid instead.
is_required - Boolean! (BETA) Indicates whether the customizable option is required.
label - String! (BETA) The display name of the selected customizable option.
sort_order - Int! (BETA) A value indicating the order to display this option.
type - String! (BETA) The type of CustomizableOptionInterface object.
values - [SelectedCustomizableOptionValue]! (BETA) An array of selectable values.
Example
{
  "customizable_option_uid": "4",
  "id": 987,
  "is_required": true,
  "label": "abc123",
  "sort_order": 123,
  "type": "xyz789",
  "values": [SelectedCustomizableOptionValue]
}

SelectedCustomizableOptionValue

Description

(BETA) Identifies the value of the selected customized option.

Fields
Field Name Description
customizable_option_value_uid - ID! (BETA) The unique ID for a value object that corresponds to the object represented by the customizable_option_uid attribute.
id - Int! Use SelectedCustomizableOptionValue.customizable_option_value_uid instead.
label - String! (BETA) The display name of the selected value.
price - CartItemSelectedOptionValuePrice! (BETA) The price of the selected customizable value.
value - String! (BETA) The text identifying the selected value.
Example
{
  "customizable_option_value_uid": "4",
  "id": 123,
  "label": "xyz789",
  "price": CartItemSelectedOptionValuePrice,
  "value": "xyz789"
}

SelectedPaymentMethod

Description

(BETA) Describes the payment method the shopper selected.

Fields
Field Name Description
code - String! (BETA) The payment method code.
purchase_order_number - String (BETA) The purchase order number.
title - String! (BETA) The payment method title.
Example
{
  "code": "xyz789",
  "purchase_order_number": "abc123",
  "title": "xyz789"
}

SelectedShippingMethod

Description

(BETA) Contains details about the selected shipping method and carrier.

Fields
Field Name Description
amount - Money! (BETA) The cost of shipping using this shipping method.
base_amount - Money The field should not be used on the storefront.
carrier_code - String! (BETA) A string that identifies a commercial carrier or an offline shipping method.
carrier_title - String! (BETA) The label for the carrier code.
method_code - String! (BETA) A shipping method code associated with a carrier.
method_title - String! (BETA) The label for the method code.
price_excl_tax - Money! (BETA) The cost of shipping using this shipping method, excluding tax.
price_incl_tax - Money! (BETA) The cost of shipping using this shipping method, including tax.
Example
{
  "amount": Money,
  "base_amount": Money,
  "carrier_code": "xyz789",
  "carrier_title": "abc123",
  "method_code": "abc123",
  "method_title": "xyz789",
  "price_excl_tax": Money,
  "price_incl_tax": Money
}

SendEmailToFriendInput

Description

(BETA) Defines the referenced product and the email sender and recipients.

Fields
Input Field Description
product_id - Int!

(BETA) The ID of the product that the sender is referencing.

recipients - [SendEmailToFriendRecipientInput]!

(BETA) An array containing information about each recipient.

sender - SendEmailToFriendSenderInput!

(BETA) Information about the customer and the content of the message.

Example
{
  "product_id": 987,
  "recipients": [SendEmailToFriendRecipientInput],
  "sender": SendEmailToFriendSenderInput
}

SendEmailToFriendOutput

Description

(BETA) Contains information about the sender and recipients.

Fields
Field Name Description
recipients - [SendEmailToFriendRecipient] (BETA) An array containing information about each recipient.
sender - SendEmailToFriendSender (BETA) Information about the customer and the content of the message.
Example
{
  "recipients": [SendEmailToFriendRecipient],
  "sender": SendEmailToFriendSender
}

SendEmailToFriendRecipient

Description

(BETA) An output object that contains information about the recipient.

Fields
Field Name Description
email - String! (BETA) The email address of the recipient.
name - String! (BETA) The name of the recipient.
Example
{
  "email": "xyz789",
  "name": "xyz789"
}

SendEmailToFriendRecipientInput

Description

(BETA) Contains details about a recipient.

Fields
Input Field Description
email - String!

(BETA) The email address of the recipient.

name - String!

(BETA) The name of the recipient.

Example
{
  "email": "abc123",
  "name": "abc123"
}

SendEmailToFriendSender

Description

(BETA) An output object that contains information about the sender.

Fields
Field Name Description
email - String! (BETA) The email address of the sender.
message - String! (BETA) The text of the message to be sent.
name - String! (BETA) The name of the sender.
Example
{
  "email": "abc123",
  "message": "abc123",
  "name": "xyz789"
}

SendEmailToFriendSenderInput

Description

(BETA) Contains details about the sender.

Fields
Input Field Description
email - String!

(BETA) The email address of the sender.

message - String!

(BETA) The text of the message to be sent.

name - String!

(BETA) The name of the sender.

Example
{
  "email": "abc123",
  "message": "xyz789",
  "name": "xyz789"
}

SendFriendConfiguration

Description

(BETA) Contains details about the configuration of the Email to a Friend feature.

Fields
Field Name Description
enabled_for_customers - Boolean! (BETA) Indicates whether the Email to a Friend feature is enabled.
enabled_for_guests - Boolean! (BETA) Indicates whether the Email to a Friend feature is enabled for guests.
Example
{"enabled_for_customers": false, "enabled_for_guests": false}

SendNegotiableQuoteForReviewInput

Description

(BETA) Specifies which negotiable quote to send for review.

Fields
Input Field Description
comment - NegotiableQuoteCommentInput

(BETA) A comment for the seller to review.

quote_uid - ID!

(BETA) The unique ID of a NegotiableQuote object.

Example
{
  "comment": NegotiableQuoteCommentInput,
  "quote_uid": "4"
}

SendNegotiableQuoteForReviewOutput

Description

(BETA) Contains the negotiable quote.

Fields
Field Name Description
quote - NegotiableQuote (BETA) The negotiable quote after sending for seller review.
Example
{"quote": NegotiableQuote}

SetBillingAddressOnCartInput

Description

(BETA) Sets the billing address.

Fields
Input Field Description
billing_address - BillingAddressInput!

(BETA) The billing address.

cart_id - String!

(BETA) The unique ID of a Cart object.

Example
{
  "billing_address": BillingAddressInput,
  "cart_id": "xyz789"
}

SetBillingAddressOnCartOutput

Description

(BETA) Contains details about the cart after setting the billing address.

Fields
Field Name Description
cart - Cart! (BETA) The cart after setting the billing address.
Example
{"cart": Cart}

SetGiftOptionsOnCartInput

Description

(BETA) Defines the gift options applied to the cart.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID that identifies the shopper's cart.

gift_message - GiftMessageInput

(BETA) Gift message details for the cart.

gift_receipt_included - Boolean!

(BETA) Whether customer requested gift receipt for the cart.

gift_wrapping_id - ID

(BETA) The unique ID for a GiftWrapping object to be used for the cart.

printed_card_included - Boolean!

(BETA) Whether customer requested printed card for the cart.

Example
{
  "cart_id": "xyz789",
  "gift_message": GiftMessageInput,
  "gift_receipt_included": false,
  "gift_wrapping_id": 4,
  "printed_card_included": false
}

SetGiftOptionsOnCartOutput

Description

(BETA) Contains the cart after gift options have been applied.

Fields
Field Name Description
cart - Cart! (BETA) The modified cart object.
Example
{"cart": Cart}

SetGuestEmailOnCartInput

Description

(BETA) Defines the guest email and cart.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID of a Cart object.

email - String!

(BETA) The email address of the guest.

Example
{
  "cart_id": "xyz789",
  "email": "xyz789"
}

SetGuestEmailOnCartOutput

Description

(BETA) Contains details about the cart after setting the email of a guest.

Fields
Field Name Description
cart - Cart! (BETA) The cart after setting the guest email.
Example
{"cart": Cart}

SetNegotiableQuoteBillingAddressInput

Description

(BETA) Sets the billing address.

Fields
Input Field Description
billing_address - NegotiableQuoteBillingAddressInput!

(BETA) The billing address to be added.

quote_uid - ID!

(BETA) The unique ID of a NegotiableQuote object.

Example
{
  "billing_address": NegotiableQuoteBillingAddressInput,
  "quote_uid": "4"
}

SetNegotiableQuoteBillingAddressOutput

Description

(BETA) Contains the negotiable quote.

Fields
Field Name Description
quote - NegotiableQuote (BETA) The negotiable quote after assigning a billing address.
Example
{"quote": NegotiableQuote}

SetNegotiableQuotePaymentMethodInput

Description

(BETA) Defines the payment method of the specified negotiable quote.

Fields
Input Field Description
payment_method - NegotiableQuotePaymentMethodInput!

(BETA) The payment method to be assigned to the negotiable quote.

quote_uid - ID!

(BETA) The unique ID of a NegotiableQuote object.

Example
{
  "payment_method": NegotiableQuotePaymentMethodInput,
  "quote_uid": "4"
}

SetNegotiableQuotePaymentMethodOutput

Description

(BETA) Contains details about the negotiable quote after setting the payment method.

Fields
Field Name Description
quote - NegotiableQuote (BETA) The updated negotiable quote.
Example
{"quote": NegotiableQuote}

SetNegotiableQuoteShippingAddressInput

Description

(BETA) Defines the shipping address to assign to the negotiable quote.

Fields
Input Field Description
customer_address_id - ID

(BETA) The unique ID of a CustomerAddress object.

quote_uid - ID!

(BETA) The unique ID of a NegotiableQuote object.

shipping_addresses - [NegotiableQuoteShippingAddressInput]

(BETA) An array of shipping addresses to apply to the negotiable quote.

Example
{
  "customer_address_id": 4,
  "quote_uid": 4,
  "shipping_addresses": [
    NegotiableQuoteShippingAddressInput
  ]
}

SetNegotiableQuoteShippingAddressOutput

Description

(BETA) Contains the negotiable quote.

Fields
Field Name Description
quote - NegotiableQuote (BETA) The negotiable quote after assigning a shipping address.
Example
{"quote": NegotiableQuote}

SetNegotiableQuoteShippingMethodsInput

Description

(BETA) Defines the shipping method to apply to the negotiable quote.

Fields
Input Field Description
quote_uid - ID!

(BETA) The unique ID of a NegotiableQuote object.

shipping_methods - [ShippingMethodInput]!

(BETA) An array of shipping methods to apply to the negotiable quote.

Example
{
  "quote_uid": 4,
  "shipping_methods": [ShippingMethodInput]
}

SetNegotiableQuoteShippingMethodsOutput

Description

(BETA) Contains the negotiable quote.

Fields
Field Name Description
quote - NegotiableQuote (BETA) The negotiable quote after applying shipping methods.
Example
{"quote": NegotiableQuote}

SetPaymentMethodAndPlaceOrderInput

Description

(BETA) Applies a payment method to the quote.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID of a Cart object.

payment_method - PaymentMethodInput!

(BETA) The payment method data to apply to the cart.

Example
{
  "cart_id": "xyz789",
  "payment_method": PaymentMethodInput
}

SetPaymentMethodOnCartInput

Description

(BETA) Applies a payment method to the cart.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID of a Cart object.

payment_method - PaymentMethodInput!

(BETA) The payment method data to apply to the cart.

Example
{
  "cart_id": "xyz789",
  "payment_method": PaymentMethodInput
}

SetPaymentMethodOnCartOutput

Description

(BETA) Contains details about the cart after setting the payment method.

Fields
Field Name Description
cart - Cart! (BETA) The cart after setting the payment method.
Example
{"cart": Cart}

SetShippingAddressesOnCartInput

Description

(BETA) Specifies an array of addresses to use for shipping.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID of a Cart object.

shipping_addresses - [ShippingAddressInput]!

(BETA) An array of shipping addresses.

Example
{
  "cart_id": "xyz789",
  "shipping_addresses": [ShippingAddressInput]
}

SetShippingAddressesOnCartOutput

Description

(BETA) Contains details about the cart after setting the shipping addresses.

Fields
Field Name Description
cart - Cart! (BETA) The cart after setting the shipping addresses.
Example
{"cart": Cart}

SetShippingMethodsOnCartInput

Description

(BETA) Applies one or shipping methods to the cart.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID of a Cart object.

shipping_methods - [ShippingMethodInput]!

(BETA) An array of shipping methods.

Example
{
  "cart_id": "xyz789",
  "shipping_methods": [ShippingMethodInput]
}

SetShippingMethodsOnCartOutput

Description

(BETA) Contains details about the cart after setting the shipping methods.

Fields
Field Name Description
cart - Cart! (BETA) The cart after setting the shipping methods.
Example
{"cart": Cart}

ShareGiftRegistryInviteeInput

Description

(BETA) Defines a gift registry invitee.

Fields
Input Field Description
email - String!

(BETA) The email address of the gift registry invitee.

name - String!

(BETA) The name of the gift registry invitee.

Example
{
  "email": "abc123",
  "name": "abc123"
}

ShareGiftRegistryOutput

Description

(BETA) Contains the results of a request to share a gift registry.

Fields
Field Name Description
is_shared - Boolean! (BETA) Indicates whether the gift registry was successfully shared.
Example
{"is_shared": true}

ShareGiftRegistrySenderInput

Description

(BETA) Defines the sender of an invitation to view a gift registry.

Fields
Input Field Description
message - String!

(BETA) A brief message from the sender.

name - String!

(BETA) The sender of the gift registry invitation.

Example
{
  "message": "xyz789",
  "name": "abc123"
}

ShipBundleItemsEnum

Description

(BETA) Defines whether bundle items must be shipped together.

Values
Enum Value Description

TOGETHER

SEPARATELY

Example
"TOGETHER"

ShipmentItem

Fields
Field Name Description
id - ID! (BETA) The unique ID for a ShipmentItemInterface object.
order_item - OrderItemInterface (BETA) The order item associated with the shipment item.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product.
product_sku - String! (BETA) The SKU of the base product.
quantity_shipped - Float! (BETA) The number of shipped items.
Example
{
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_shipped": 987.65
}

ShipmentItemInterface

Description

(BETA) Order shipment item details.

Fields
Field Name Description
id - ID! (BETA) The unique ID for a ShipmentItemInterface object.
order_item - OrderItemInterface (BETA) The order item associated with the shipment item.
product_name - String (BETA) The name of the base product.
product_sale_price - Money! (BETA) The sale price for the base product.
product_sku - String! (BETA) The SKU of the base product.
quantity_shipped - Float! (BETA) The number of shipped items.
Possible Types
ShipmentItemInterface Types

BundleShipmentItem

GiftCardShipmentItem

ShipmentItem

Example
{
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_shipped": 987.65
}

ShipmentTracking

Description

(BETA) Contains order shipment tracking details.

Fields
Field Name Description
carrier - String! (BETA) The shipping carrier for the order delivery.
number - String (BETA) The tracking number of the order shipment.
title - String! (BETA) The shipment tracking title.
Example
{
  "carrier": "xyz789",
  "number": "xyz789",
  "title": "abc123"
}

ShippingAddressInput

Description

(BETA) Defines a single shipping address.

Fields
Input Field Description
address - CartAddressInput

(BETA) Defines a shipping address.

customer_address_id - Int

(BETA) An ID from the customer's address book that uniquely identifies the address to be used for shipping.

customer_notes - String

(BETA) Text provided by the shopper.

pickup_location_code - String

(BETA) The code of Pickup Location which will be used for In-Store Pickup.

Example
{
  "address": CartAddressInput,
  "customer_address_id": 123,
  "customer_notes": "abc123",
  "pickup_location_code": "abc123"
}

ShippingCartAddress

Description

(BETA) Contains shipping addresses and methods.

Fields
Field Name Description
available_shipping_methods - [AvailableShippingMethod] (BETA) An array that lists the shipping methods that can be applied to the cart.
cart_items - [CartItemQuantity] Use cart_items_v2 instead.
cart_items_v2 - [CartItemInterface] (BETA) An array that lists the items in the cart.
city - String! (BETA) The city specified for the billing or shipping address.
company - String (BETA) The company specified for the billing or shipping address.
country - CartAddressCountry! (BETA) An object containing the country label and code.
customer_notes - String (BETA) Text provided by the shopper.
firstname - String! (BETA) The first name of the customer or guest.
items_weight - Float This information should not be exposed on the frontend.
lastname - String! (BETA) The last name of the customer or guest.
pickup_location_code - String
postcode - String (BETA) The ZIP or postal code of the billing or shipping address.
region - CartAddressRegion (BETA) An object containing the region label and code.
selected_shipping_method - SelectedShippingMethod (BETA) An object that describes the selected shipping method.
street - [String]! (BETA) An array containing the street for the billing or shipping address.
telephone - String (BETA) The telephone number for the billing or shipping address.
uid - String! (BETA) The unique id of the customer address.
vat_id - String (BETA) The VAT company number for billing or shipping address.
Example
{
  "available_shipping_methods": [AvailableShippingMethod],
  "cart_items": [CartItemQuantity],
  "cart_items_v2": [CartItemInterface],
  "city": "xyz789",
  "company": "abc123",
  "country": CartAddressCountry,
  "customer_notes": "xyz789",
  "firstname": "xyz789",
  "items_weight": 123.45,
  "lastname": "xyz789",
  "pickup_location_code": "xyz789",
  "postcode": "abc123",
  "region": CartAddressRegion,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["abc123"],
  "telephone": "abc123",
  "uid": "abc123",
  "vat_id": "xyz789"
}

ShippingDiscount

Description

(BETA) Defines an individual shipping discount. This discount can be applied to shipping.

Fields
Field Name Description
amount - Money! (BETA) The amount of the discount.
Example
{"amount": Money}

ShippingHandling

Description

(BETA) Contains details about shipping and handling costs.

Fields
Field Name Description
amount_excluding_tax - Money (BETA) The shipping amount, excluding tax.
amount_including_tax - Money (BETA) The shipping amount, including tax.
discounts - [ShippingDiscount] (BETA) The applied discounts to the shipping.
taxes - [TaxItem] (BETA) Details about taxes applied for shipping.
total_amount - Money! (BETA) The total amount for shipping.
Example
{
  "amount_excluding_tax": Money,
  "amount_including_tax": Money,
  "discounts": [ShippingDiscount],
  "taxes": [TaxItem],
  "total_amount": Money
}

ShippingMethodInput

Description

(BETA) Defines the shipping carrier and method.

Fields
Input Field Description
carrier_code - String!

(BETA) A string that identifies a commercial carrier or an offline delivery method.

method_code - String!

(BETA) A string that indicates which service a commercial carrier will use to ship items. For offline delivery methods, this value is similar to the label displayed on the checkout page.

Example
{
  "carrier_code": "abc123",
  "method_code": "xyz789"
}

SimpleCartItem

Description

(BETA) An implementation for simple product cart items.

Fields
Field Name Description
available_gift_wrapping - [GiftWrapping]! (BETA) The list of available gift wrapping options for the cart item.
customizable_options - [SelectedCustomizableOption]! (BETA) An array containing the customizable options the shopper selected.
errors - [CartItemError] (BETA) An array of errors encountered while loading the cart item
gift_message - GiftMessage (BETA) The entered gift message for the cart item
gift_wrapping - GiftWrapping (BETA) The selected gift wrapping for the cart item.
id - String! Use uid instead.
prices - CartItemPrices (BETA) Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! (BETA) Details about an item in the cart.
quantity - Float! (BETA) The quantity of this item in the cart.
uid - ID! (BETA) The unique ID for a CartItemInterface object.
Example
{
  "available_gift_wrapping": [GiftWrapping],
  "customizable_options": [SelectedCustomizableOption],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "xyz789",
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": 4
}

SimpleProduct

Description

(BETA) Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities.

Fields
Field Name Description
activity - String Use the custom_attributes field instead.
attribute_set_id - Int (BETA) The attribute set assigned to the product. The field should not be used on the storefront.
canonical_url - String (BETA) The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] (BETA) The categories assigned to a product.
category_gear - String Use the custom_attributes field instead.
climate - String Use the custom_attributes field instead.
collar - String Use the custom_attributes field instead.
color - Int Use the custom_attributes field instead.
country_of_manufacture - String (BETA) The product's country of origin.
created_at - String (BETA) Timestamp indicating when the product was created. The field should not be used on the storefront.
crosssell_products - [ProductInterface] (BETA) An array of cross-sell products.
description - ComplexTextValue (BETA) Detailed information about the product. The value can include simple HTML tags.
eco_collection - Int Use the custom_attributes field instead.
erin_recommends - Int Use the custom_attributes field instead.
features_bags - String Use the custom_attributes field instead.
format - Int Use the custom_attributes field instead.
gender - String Use the custom_attributes field instead.
gift_message_available - String (BETA) Indicates whether a gift message is available.
id - Int (BETA) The ID number assigned to the product. Use the uid field instead.
image - ProductImage (BETA) The relative path to the main image on the product page.
is_returnable - String (BETA) Indicates whether the product can be returned.
manufacturer - Int (BETA) A number representing the product's manufacturer. Use the custom_attributes field instead.
material - String Use the custom_attributes field instead.
media_gallery - [MediaGalleryInterface] (BETA) An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] (BETA) An array of MediaGalleryEntry objects. Use media_gallery instead.
meta_description - String (BETA) A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String (BETA) A comma-separated list of keywords that are visible only to search engines.
meta_title - String (BETA) A string that is displayed in the title bar and tab of the browser and in search results lists.
name - String (BETA) The product name. Customers use this name to identify the product.
new - Int Use the custom_attributes field instead.
new_from_date - String (BETA) The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String (BETA) The end date for new product listings.
only_x_left_in_stock - Float (BETA) Product stock only x left count
options - [CustomizableOptionInterface] (BETA) An array of options for a customizable product.
options_container - String (BETA) If the product has multiple options, determines where they appear on the product page.
pattern - String Use the custom_attributes field instead.
performance_fabric - Int Use the custom_attributes field instead.
price - ProductPrices (BETA) Indicates the price of an item. Use price_range for product price information.
price_range - PriceRange! (BETA) The range of prices for the product
price_tiers - [TierPrice] (BETA) An array of TierPrice objects.
product_links - [ProductLinksInterface] (BETA) An array of ProductLinks objects.
purpose - Int Use the custom_attributes field instead.
rating_summary - Float! (BETA) The average of all the ratings given to the product.
redirect_code - Int! (BETA) Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] (BETA) An array of related products.
relative_url - String (BETA) The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! (BETA) The total count of all the reviews given to the product.
reviews - ProductReviews! (BETA) The list of products reviews.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default is 20.

currentPage - Int

(BETA) The page of results to return. The default is 1.

sale - Int Use the custom_attributes field instead.
short_description - ComplexTextValue (BETA) A short description of the product. Its use depends on the theme.
size - Int Use the custom_attributes field instead.
sku - String (BETA) A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String Use the custom_attributes field instead.
small_image - ProductImage (BETA) The relative path to the small image, which is used on catalog pages.
special_from_date - String (BETA) The beginning date that a product has a special price. The field should not be used on the storefront.
special_price - Float (BETA) The discounted price of the product.
special_to_date - String (BETA) The end date for a product with a special price.
staged - Boolean! (BETA) Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus (BETA) Stock status of the product
strap_bags - String Use the custom_attributes field instead.
style_bags - String Use the custom_attributes field instead.
style_bottom - String Use the custom_attributes field instead.
style_general - String Use the custom_attributes field instead.
swatch_image - String (BETA) The file name of a swatch image.
thumbnail - ProductImage (BETA) The relative path to the product's thumbnail image.
tier_price - Float (BETA) The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information.
tier_prices - [ProductTierPrices] (BETA) An array of ProductTierPrices objects. Use price_tiers for product tier price information.
type - UrlRewriteEntityTypeEnum (BETA) One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String (BETA) One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead.
uid - ID! (BETA) The unique ID for a ProductInterface object.
updated_at - String (BETA) Timestamp indicating when the product was updated. The field should not be used on the storefront.
upsell_products - [ProductInterface] (BETA) An array of up-sell products.
url_key - String (BETA) The part of the URL that identifies the product
url_path - String Use product's canonical_url or url rewrites instead
url_rewrites - [UrlRewrite] (BETA) URL rewrites list
url_suffix - String (BETA) The part of the product URL that is appended after the url key
websites - [Website] (BETA) An array of websites in which the product is available. The field should not be used on the storefront.
weight - Float (BETA) The weight of the item, in units defined by the store.
Example
{
  "activity": "xyz789",
  "attribute_set_id": 987,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "category_gear": "abc123",
  "climate": "xyz789",
  "collar": "abc123",
  "color": 123,
  "country_of_manufacture": "abc123",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "description": ComplexTextValue,
  "eco_collection": 123,
  "erin_recommends": 987,
  "features_bags": "abc123",
  "format": 987,
  "gender": "xyz789",
  "gift_message_available": "xyz789",
  "id": 987,
  "image": ProductImage,
  "is_returnable": "abc123",
  "manufacturer": 987,
  "material": "xyz789",
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "abc123",
  "meta_title": "abc123",
  "name": "xyz789",
  "new": 987,
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 987.65,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "pattern": "xyz789",
  "performance_fabric": 123,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 123,
  "rating_summary": 987.65,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 987,
  "reviews": ProductReviews,
  "sale": 987,
  "short_description": ComplexTextValue,
  "size": 123,
  "sku": "xyz789",
  "sleeve": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "strap_bags": "abc123",
  "style_bags": "abc123",
  "style_bottom": "xyz789",
  "style_general": "xyz789",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 123.45,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "xyz789",
  "uid": "4",
  "updated_at": "abc123",
  "upsell_products": [ProductInterface],
  "url_key": "xyz789",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "xyz789",
  "websites": [Website],
  "weight": 123.45
}

SimpleProductCartItemInput

Description

(BETA) Defines a single product to add to the cart.

Fields
Input Field Description
customizable_options - [CustomizableOptionInput]

(BETA) An array that defines customizable options for the product.

data - CartItemInput!

(BETA) An object containing the sku, quantity, and other relevant information about the product.

Example
{
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput
}

SimpleRequisitionListItem

Description

(BETA) Contains details about simple products added to a requisition list.

Fields
Field Name Description
customizable_options - [SelectedCustomizableOption]! (BETA) Selected custom options for an item in the requisition list.
product - ProductInterface! (BETA) Details about a requisition list item.
quantity - Float! (BETA) The amount added.
uid - ID! (BETA) The unique ID for the requisition list item.
Example
{
  "customizable_options": [SelectedCustomizableOption],
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": "4"
}

SimpleWishlistItem

Description

(BETA) Contains a simple product wish list item.

Fields
Field Name Description
added_at - String! (BETA) The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]! (BETA) Custom options selected for the wish list item.
description - String (BETA) The description of the item.
id - ID! (BETA) The unique ID for a WishlistItemInterface object.
product - ProductInterface (BETA) Product details of the wish list item.
quantity - Float! (BETA) The quantity of this wish list item.
Example
{
  "added_at": "xyz789",
  "customizable_options": [SelectedCustomizableOption],
  "description": "abc123",
  "id": "4",
  "product": ProductInterface,
  "quantity": 987.65
}

SortEnum

Description

(BETA) Indicates whether to return results in ascending or descending order.

Values
Enum Value Description

ASC

DESC

Example
"ASC"

SortField

Description

(BETA) Defines a possible sort field.

Fields
Field Name Description
label - String (BETA) The label of the sort field.
value - String (BETA) The attribute code of the sort field.
Example
{
  "label": "xyz789",
  "value": "xyz789"
}

SortFields

Description

(BETA) Contains a default value for sort fields and all available sort fields.

Fields
Field Name Description
default - String (BETA) The default sort field value.
options - [SortField] (BETA) An array of possible sort fields.
Example
{
  "default": "xyz789",
  "options": [SortField]
}

StoreConfig

Description

(BETA) Contains information about a store's configuration.

Fields
Field Name Description
absolute_footer - String (BETA) Contains scripts that must be included in the HTML before the closing <body> tag.
allow_gift_receipt - String (BETA) Indicates if the gift sender has the option to send a gift receipt. Possible values: 1 (Yes) and 0 (No).
allow_gift_wrapping_on_order - String (BETA) Indicates whether gift wrapping can be added for the entire order. Possible values: 1 (Yes) and 0 (No).
allow_gift_wrapping_on_order_items - String (BETA) Indicates whether gift wrapping can be added for individual order items. Possible values: 1 (Yes) and 0 (No).
allow_guests_to_write_product_reviews - String (BETA) Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No).
allow_items - String (BETA) The value of the Allow Gift Messages for Order Items option
allow_order - String (BETA) The value of the Allow Gift Messages on Order Level option
allow_printed_card - String (BETA) Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No).
autocomplete_on_storefront - Boolean (BETA) Indicates whether to enable autocomplete on login and forgot password forms.
base_currency_code - String (BETA) The base currency code.
base_link_url - String (BETA) A fully-qualified URL that is used to create relative links to the base_url.
base_media_url - String (BETA) The fully-qualified URL that specifies the location of media files.
base_static_url - String (BETA) The fully-qualified URL that specifies the location of static view files.
base_url - String (BETA) The store’s fully-qualified base URL.
braintree_cc_vault_active - String (BETA) Braintree cc vault status.
cart_gift_wrapping - String (BETA) Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).
cart_printed_card - String (BETA) Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).
catalog_default_sort_by - String (BETA) The default sort order of the search results list.
category_fixed_product_tax_display_setting - FixedProductTaxDisplaySettings (BETA) Corresponds to the 'Display Prices In Product Lists' field in the Admin. It indicates how FPT information is displayed on category pages.
category_url_suffix - String (BETA) The suffix applied to category pages, such as .htm or .html.
check_money_order_enable_for_specific_countries - Boolean (BETA) Indicates whether only specific countries can use this payment method.
check_money_order_enabled - Boolean (BETA) Indicates whether the Check/Money Order payment method is enabled.
check_money_order_make_check_payable_to - String (BETA) The name of the party to whom the check must be payable.
check_money_order_max_order_total - String (BETA) The maximum order amount required to qualify for the Check/Money Order payment method.
check_money_order_min_order_total - String (BETA) The minimum order amount required to qualify for the Check/Money Order payment method.
check_money_order_new_order_status - String (BETA) The status of new orders placed using the Check/Money Order payment method.
check_money_order_payment_from_specific_countries - String (BETA) A comma-separated list of specific countries allowed to use the Check/Money Order payment method.
check_money_order_send_check_to - String (BETA) The full street address or PO Box where the checks are mailed.
check_money_order_sort_order - Int (BETA) A number indicating the position of the Check/Money Order payment method in the list of available payment methods during checkout.
check_money_order_title - String (BETA) The title of the Check/Money Order payment method displayed on the storefront.
cms_home_page - String (BETA) The name of the CMS page that identifies the home page for the store.
cms_no_cookies - String (BETA) A specific CMS page that displays when cookies are not enabled for the browser.
cms_no_route - String (BETA) A specific CMS page that displays when a 404 'Page Not Found' error occurs.
code - String (BETA) A code assigned to the store to identify it. Use store_code instead.
configurable_thumbnail_source - String (BETA) Indicates whether the parent or child (itself) thumbnail should be used in the cart for configurable products.
copyright - String (BETA) The copyright statement that appears at the bottom of each page.
default_description - String (BETA) The description that provides a summary of your site for search engine listings. It should not be more than 160 characters in length.
default_display_currency_code - String (BETA) The default display currency code.
default_keywords - String (BETA) A series of keywords that describe your store, each separated by a comma.
default_title - String (BETA) The title that appears at the title bar of each page when viewed in a browser.
demonotice - Int (BETA) Controls the display of the demo store notice at the top of the page. Options: 0 (No) or 1 (Yes).
enable_multiple_wishlists - String (BETA) Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No).
front - String (BETA) The landing page that is associated with the base URL.
grid_per_page - Int (BETA) The default number of products per page in Grid View.
grid_per_page_values - String (BETA) A list of numbers that define how many products can be displayed in Grid View.
head_includes - String (BETA) Scripts that must be included in the HTML before the closing <head> tag.
head_shortcut_icon - String (BETA) The small graphic image (favicon) that appears in the address bar and tab of the browser.
header_logo_src - String (BETA) The path to the logo that appears in the header.
id - Int (BETA) The ID number assigned to the store. Use store_code instead.
is_default_store - Boolean (BETA) Indicates whether the store view has been designated as the default within the store group.
is_default_store_group - Boolean (BETA) Indicates whether the store group has been designated as the default within the website.
is_negotiable_quote_active - Boolean (BETA) Indicates whether negotiable quote functionality is enabled.
is_requisition_list_active - String (BETA) Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No).
list_mode - String (BETA) The format of the search results list.
list_per_page - Int (BETA) The default number of products per page in List View.
list_per_page_values - String (BETA) A list of numbers that define how many products can be displayed in List View.
locale - String (BETA) The store locale.
logo_alt - String (BETA) The Alt text that is associated with the logo.
logo_height - Int (BETA) The height of the logo image, in pixels.
logo_width - Int (BETA) The width of the logo image, in pixels.
magento_reward_general_is_enabled - String (BETA) Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled).
magento_reward_general_is_enabled_on_front - String (BETA) Indicates whether reward points functionality is enabled on the storefront. Possible values: 1 (Enabled) and 0 (Disabled).
magento_reward_general_min_points_balance - String (BETA) The minimum point balance customers must have before they can redeem them. A null value indicates no minimum.
magento_reward_general_publish_history - String (BETA) When enabled, customers can see a detailed history of their reward points. Possible values: 1 (Enabled) and 0 (Disabled).
magento_reward_points_invitation_customer - String (BETA) The number of points for a referral when an invitee registers on the site.
magento_reward_points_invitation_customer_limit - String (BETA) The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit.
magento_reward_points_invitation_order - String (BETA) The number of points for a referral, when an invitee places their first order on the site.
magento_reward_points_invitation_order_limit - String (BETA) The number of order conversions that can earn points for the customer who sends the invitation. A null value indicates no limit.
magento_reward_points_newsletter - String (BETA) The number of points earned by registered customers who subscribe to a newsletter.
magento_reward_points_order - String (BETA) Indicates customers earn points for shopping according to the reward point exchange rate. In Luma, this also controls whether to show a message in the shopping cart about the rewards points earned for the purchase, as well as the customer’s current reward point balance.
magento_reward_points_register - String (BETA) The number of points customer gets for registering.
magento_reward_points_review - String (BETA) The number of points for writing a review.
magento_reward_points_review_limit - String (BETA) The maximum number of reviews that will qualify for the rewards. A null value indicates no limit.
magento_wishlist_general_is_enabled - String (BETA) Indicates whether wishlists are enabled (1) or disabled (0).
maximum_number_of_wishlists - String (BETA) If multiple wish lists are enabled, the maximum number of wish lists the customer can have.
minimum_password_length - String (BETA) The minimum number of characters required for a valid password.
no_route - String (BETA) The default page that displays when a 404 'Page not Found' error occurs.
payment_payflowpro_cc_vault_active - String (BETA) Payflow Pro vault status.
printed_card_price - String (BETA) The default price of a printed card that accompanies an order.
product_fixed_product_tax_display_setting - FixedProductTaxDisplaySettings (BETA) Corresponds to the 'Display Prices On Product View Page' field in the Admin. It indicates how FPT information is displayed on product pages.
product_reviews_enabled - String (BETA) Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No).
product_url_suffix - String (BETA) The suffix applied to product pages, such as .htm or .html.
required_character_classes_number - String (BETA) The number of different character classes (lowercase, uppercase, digits, special characters) required in a password.
returns_enabled - String! (BETA) Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled.
root_category_id - Int (BETA) The ID of the root category. Use root_category_uid instead.
root_category_uid - ID (BETA) The unique ID for a CategoryInterface object.
sales_fixed_product_tax_display_setting - FixedProductTaxDisplaySettings (BETA) Corresponds to the 'Display Prices In Sales Modules' field in the Admin. It indicates how FPT information is displayed on cart, checkout, and order pages.
sales_gift_wrapping - String (BETA) Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No).
sales_printed_card - String (BETA) Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No).
secure_base_link_url - String (BETA) A secure fully-qualified URL that is used to create relative links to the base_url.
secure_base_media_url - String (BETA) The secure fully-qualified URL that specifies the location of media files.
secure_base_static_url - String (BETA) The secure fully-qualified URL that specifies the location of static view files.
secure_base_url - String (BETA) The store’s fully-qualified secure base URL.
send_friend - SendFriendConfiguration (BETA) Email to a Friend configuration.
show_cms_breadcrumbs - Int (BETA) Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes).
store_code - ID (BETA) The unique ID of the store view. In the Admin, this is called the Store View Code. When making a GraphQL call, assign this value to the Store header to provide the scope.
store_group_code - ID (BETA) The unique ID assigned to the store group. In the Admin, this is called the Store Name.
store_group_name - String (BETA) The label assigned to the store group.
store_name - String (BETA) The label assigned to the store view.
store_sort_order - Int (BETA) The store view sort order.
timezone - String (BETA) The time zone of the store.
title_prefix - String (BETA) A prefix that appears before the title to create a two- or three-part title.
title_separator - String (BETA) The character that separates the category name and subcategory in the browser title bar.
title_suffix - String (BETA) A suffix that appears after the title to create a two- or three-part title.
use_store_in_url - Boolean (BETA) Indicates whether the store code should be used in the URL.
website_code - ID (BETA) The unique ID for the website.
website_id - Int (BETA) The ID number assigned to the website store. The field should not be used on the storefront.
website_name - String (BETA) The label assigned to the website.
weight_unit - String (BETA) The unit of weight.
welcome - String (BETA) Text that appears in the header of the page and includes the name of the logged in customer.
zero_subtotal_enable_for_specific_countries - Boolean (BETA) Indicates whether only specific countries can use this payment method.
zero_subtotal_enabled - Boolean (BETA) Indicates whether the Zero Subtotal payment method is enabled.
zero_subtotal_new_order_status - String (BETA) The status of new orders placed using the Zero Subtotal payment method.
zero_subtotal_payment_action - String (BETA) When the new order status is 'Processing', this can be set to authorize_capture to automatically invoice all items that have a zero balance.
zero_subtotal_payment_from_specific_countries - String (BETA) A comma-separated list of specific countries allowed to use the Zero Subtotal payment method.
zero_subtotal_sort_order - Int (BETA) A number indicating the position of the Zero Subtotal payment method in the list of available payment methods during checkout.
zero_subtotal_title - String (BETA) The title of the Zero Subtotal payment method displayed on the storefront.
Example
{
  "absolute_footer": "abc123",
  "allow_gift_receipt": "xyz789",
  "allow_gift_wrapping_on_order": "xyz789",
  "allow_gift_wrapping_on_order_items": "abc123",
  "allow_guests_to_write_product_reviews": "abc123",
  "allow_items": "abc123",
  "allow_order": "xyz789",
  "allow_printed_card": "xyz789",
  "autocomplete_on_storefront": true,
  "base_currency_code": "abc123",
  "base_link_url": "abc123",
  "base_media_url": "xyz789",
  "base_static_url": "abc123",
  "base_url": "abc123",
  "braintree_cc_vault_active": "abc123",
  "cart_gift_wrapping": "abc123",
  "cart_printed_card": "abc123",
  "catalog_default_sort_by": "xyz789",
  "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
  "category_url_suffix": "xyz789",
  "check_money_order_enable_for_specific_countries": true,
  "check_money_order_enabled": false,
  "check_money_order_make_check_payable_to": "xyz789",
  "check_money_order_max_order_total": "abc123",
  "check_money_order_min_order_total": "abc123",
  "check_money_order_new_order_status": "xyz789",
  "check_money_order_payment_from_specific_countries": "abc123",
  "check_money_order_send_check_to": "abc123",
  "check_money_order_sort_order": 123,
  "check_money_order_title": "xyz789",
  "cms_home_page": "abc123",
  "cms_no_cookies": "abc123",
  "cms_no_route": "abc123",
  "code": "abc123",
  "configurable_thumbnail_source": "xyz789",
  "copyright": "abc123",
  "default_description": "abc123",
  "default_display_currency_code": "abc123",
  "default_keywords": "xyz789",
  "default_title": "abc123",
  "demonotice": 123,
  "enable_multiple_wishlists": "abc123",
  "front": "xyz789",
  "grid_per_page": 987,
  "grid_per_page_values": "xyz789",
  "head_includes": "abc123",
  "head_shortcut_icon": "xyz789",
  "header_logo_src": "abc123",
  "id": 123,
  "is_default_store": true,
  "is_default_store_group": false,
  "is_negotiable_quote_active": false,
  "is_requisition_list_active": "xyz789",
  "list_mode": "abc123",
  "list_per_page": 123,
  "list_per_page_values": "abc123",
  "locale": "abc123",
  "logo_alt": "xyz789",
  "logo_height": 987,
  "logo_width": 123,
  "magento_reward_general_is_enabled": "xyz789",
  "magento_reward_general_is_enabled_on_front": "abc123",
  "magento_reward_general_min_points_balance": "xyz789",
  "magento_reward_general_publish_history": "abc123",
  "magento_reward_points_invitation_customer": "xyz789",
  "magento_reward_points_invitation_customer_limit": "abc123",
  "magento_reward_points_invitation_order": "xyz789",
  "magento_reward_points_invitation_order_limit": "abc123",
  "magento_reward_points_newsletter": "abc123",
  "magento_reward_points_order": "xyz789",
  "magento_reward_points_register": "abc123",
  "magento_reward_points_review": "abc123",
  "magento_reward_points_review_limit": "abc123",
  "magento_wishlist_general_is_enabled": "xyz789",
  "maximum_number_of_wishlists": "xyz789",
  "minimum_password_length": "xyz789",
  "no_route": "xyz789",
  "payment_payflowpro_cc_vault_active": "abc123",
  "printed_card_price": "xyz789",
  "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
  "product_reviews_enabled": "xyz789",
  "product_url_suffix": "xyz789",
  "required_character_classes_number": "abc123",
  "returns_enabled": "xyz789",
  "root_category_id": 123,
  "root_category_uid": "4",
  "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
  "sales_gift_wrapping": "abc123",
  "sales_printed_card": "abc123",
  "secure_base_link_url": "abc123",
  "secure_base_media_url": "xyz789",
  "secure_base_static_url": "abc123",
  "secure_base_url": "xyz789",
  "send_friend": SendFriendConfiguration,
  "show_cms_breadcrumbs": 123,
  "store_code": "4",
  "store_group_code": "4",
  "store_group_name": "xyz789",
  "store_name": "abc123",
  "store_sort_order": 123,
  "timezone": "xyz789",
  "title_prefix": "abc123",
  "title_separator": "abc123",
  "title_suffix": "abc123",
  "use_store_in_url": true,
  "website_code": 4,
  "website_id": 123,
  "website_name": "xyz789",
  "weight_unit": "xyz789",
  "welcome": "abc123",
  "zero_subtotal_enable_for_specific_countries": true,
  "zero_subtotal_enabled": false,
  "zero_subtotal_new_order_status": "abc123",
  "zero_subtotal_payment_action": "abc123",
  "zero_subtotal_payment_from_specific_countries": "xyz789",
  "zero_subtotal_sort_order": 987,
  "zero_subtotal_title": "xyz789"
}

StorefrontProperties

Description

(BETA) Indicates where an attribute can be displayed.

Fields
Field Name Description
position - Int (BETA) The relative position of the attribute in the layered navigation block.
use_in_layered_navigation - UseInLayeredNavigationOptions (BETA) Indicates whether the attribute is filterable with results, without results, or not at all.
use_in_product_listing - Boolean (BETA) Indicates whether the attribute is displayed in product listings.
use_in_search_results_layered_navigation - Boolean (BETA) Indicates whether the attribute can be used in layered navigation on search results pages.
visible_on_catalog_pages - Boolean (BETA) Indicates whether the attribute is displayed on product pages.
Example
{
  "position": 987,
  "use_in_layered_navigation": "NO",
  "use_in_product_listing": false,
  "use_in_search_results_layered_navigation": false,
  "visible_on_catalog_pages": true
}

String

Description

(BETA) The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"

SubscribeEmailToNewsletterOutput

Description

(BETA) Contains the result of the subscribeEmailToNewsletter operation.

Fields
Field Name Description
status - SubscriptionStatusesEnum (BETA) The status of the subscription request.
Example
{"status": "NOT_ACTIVE"}

SubscriptionStatusesEnum

Description

(BETA) Indicates the status of the request.

Values
Enum Value Description

NOT_ACTIVE

SUBSCRIBED

UNSUBSCRIBED

UNCONFIRMED

Example
"NOT_ACTIVE"

SwatchData

Description

(BETA) Describes the swatch type and a value.

Fields
Field Name Description
type - String (BETA) The type of swatch filter item: 1 - text; 2 - image.
value - String (BETA) The value for the swatch item. It could be text or an image link.
Example
{
  "type": "abc123",
  "value": "abc123"
}

SwatchDataInterface

Fields
Field Name Description
value - String (BETA) The value can be represented as color (HEX code), image link, or text.
Possible Types
SwatchDataInterface Types

ImageSwatchData

TextSwatchData

ColorSwatchData

Example
{"value": "xyz789"}

SwatchLayerFilterItem

Fields
Field Name Description
items_count - Int (BETA) The count of items per filter. Use AggregationOption.count instead.
label - String (BETA) The label for a filter. Use AggregationOption.label instead.
swatch_data - SwatchData (BETA) Data required to render a swatch filter item.
value_string - String (BETA) The value of a filter request variable to be used in query. Use AggregationOption.value instead.
Example
{
  "items_count": 987,
  "label": "abc123",
  "swatch_data": SwatchData,
  "value_string": "xyz789"
}

SwatchLayerFilterItemInterface

Fields
Field Name Description
swatch_data - SwatchData (BETA) Data required to render a swatch filter item.
Possible Types
SwatchLayerFilterItemInterface Types

SwatchLayerFilterItem

Example
{"swatch_data": SwatchData}

TaxItem

Description

(BETA) Contains tax item details.

Fields
Field Name Description
amount - Money! (BETA) The amount of tax applied to the item.
rate - Float! (BETA) The rate used to calculate the tax.
title - String! (BETA) A title that describes the tax.
Example
{
  "amount": Money,
  "rate": 123.45,
  "title": "abc123"
}

TextSwatchData

Fields
Field Name Description
value - String (BETA) The value can be represented as color (HEX code), image link, or text.
Example
{"value": "abc123"}

TierPrice

Description

(BETA) Defines a price based on the quantity purchased.

Fields
Field Name Description
discount - ProductDiscount (BETA) The price discount that this tier represents.
final_price - Money (BETA) The price of the product at this tier.
quantity - Float (BETA) The minimum number of items that must be purchased to qualify for this price tier.
Example
{
  "discount": ProductDiscount,
  "final_price": Money,
  "quantity": 123.45
}

UpdateCartItemsInput

Description

(BETA) Modifies the specified items in the cart.

Fields
Input Field Description
cart_id - String!

(BETA) The unique ID of a Cart object.

cart_items - [CartItemUpdateInput]!

(BETA) An array of items to be updated.

Example
{
  "cart_id": "xyz789",
  "cart_items": [CartItemUpdateInput]
}

UpdateCartItemsOutput

Description

(BETA) Contains details about the cart after updating items.

Fields
Field Name Description
cart - Cart! (BETA) The cart after updating products.
Example
{"cart": Cart}

UpdateCompanyOutput

Description

(BETA) Contains the response to the request to update the company.

Fields
Field Name Description
company - Company! (BETA) The updated company instance.
Example
{"company": Company}

UpdateCompanyRoleOutput

Description

(BETA) Contains the response to the request to update the company role.

Fields
Field Name Description
role - CompanyRole! (BETA) The updated company role instance.
Example
{"role": CompanyRole}

UpdateCompanyStructureOutput

Description

(BETA) Contains the response to the request to update the company structure.

Fields
Field Name Description
company - Company! (BETA) The updated company instance.
Example
{"company": Company}

UpdateCompanyTeamOutput

Description

(BETA) Contains the response to the request to update a company team.

Fields
Field Name Description
team - CompanyTeam! (BETA) The updated company team instance.
Example
{"team": CompanyTeam}

UpdateCompanyUserOutput

Description

(BETA) Contains the response to the request to update the company user.

Fields
Field Name Description
user - Customer! (BETA) The updated company user instance.
Example
{"user": Customer}

UpdateGiftRegistryInput

Description

(BETA) Defines updates to a GiftRegistry object.

Fields
Input Field Description
dynamic_attributes - [GiftRegistryDynamicAttributeInput]

(BETA) Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed.

event_name - String

(BETA) The updated name of the event.

message - String

(BETA) The updated message describing the event.

privacy_settings - GiftRegistryPrivacySettings

(BETA) Indicates whether the gift registry is PRIVATE or PUBLIC.

shipping_address - GiftRegistryShippingAddressInput

(BETA) The updated shipping address for all gift registry items.

status - GiftRegistryStatus

(BETA) Indicates whether the gift registry is ACTIVE or INACTIVE.

Example
{
  "dynamic_attributes": [
    GiftRegistryDynamicAttributeInput
  ],
  "event_name": "xyz789",
  "message": "abc123",
  "privacy_settings": "PRIVATE",
  "shipping_address": GiftRegistryShippingAddressInput,
  "status": "ACTIVE"
}

UpdateGiftRegistryItemInput

Description

(BETA) Defines updates to an item in a gift registry.

Fields
Input Field Description
gift_registry_item_uid - ID!

(BETA) The unique ID of a giftRegistryItem object.

note - String

(BETA) The updated description of the item.

quantity - Float!

(BETA) The updated quantity of the gift registry item.

Example
{
  "gift_registry_item_uid": "4",
  "note": "abc123",
  "quantity": 987.65
}

UpdateGiftRegistryItemsOutput

Description

(BETA) Contains the results of a request to update gift registry items.

Fields
Field Name Description
gift_registry - GiftRegistry (BETA) The gift registry after updating updating items.
Example
{"gift_registry": GiftRegistry}

UpdateGiftRegistryOutput

Description

(BETA) Contains the results of a request to update a gift registry.

Fields
Field Name Description
gift_registry - GiftRegistry (BETA) The updated gift registry.
Example
{"gift_registry": GiftRegistry}

UpdateGiftRegistryRegistrantInput

Description

(BETA) Defines updates to an existing registrant.

Fields
Input Field Description
dynamic_attributes - [GiftRegistryDynamicAttributeInput]

(BETA) As a result of the update, only the values of provided attributes will be affected. If the attribute is missing in the request, its value will not be changed.

email - String

(BETA) The updated email address of the registrant.

firstname - String

(BETA) The updated first name of the registrant.

gift_registry_registrant_uid - ID!

(BETA) The unique ID of a giftRegistryRegistrant object.

lastname - String

(BETA) The updated last name of the registrant.

Example
{
  "dynamic_attributes": [
    GiftRegistryDynamicAttributeInput
  ],
  "email": "abc123",
  "firstname": "abc123",
  "gift_registry_registrant_uid": "4",
  "lastname": "xyz789"
}

UpdateGiftRegistryRegistrantsOutput

Description

(BETA) Contains the results a request to update registrants.

Fields
Field Name Description
gift_registry - GiftRegistry (BETA) The gift registry after updating registrants.
Example
{"gift_registry": GiftRegistry}

UpdateNegotiableQuoteItemsQuantityOutput

Description

(BETA) Contains the updated negotiable quote.

Fields
Field Name Description
quote - NegotiableQuote (BETA) The updated negotiable quote.
Example
{"quote": NegotiableQuote}

UpdateNegotiableQuoteQuantitiesInput

Description

(BETA) Specifies the items to update.

Fields
Input Field Description
items - [NegotiableQuoteItemQuantityInput]!

(BETA) An array of items to update.

quote_uid - ID!

(BETA) The unique ID of a NegotiableQuote object.

Example
{
  "items": [NegotiableQuoteItemQuantityInput],
  "quote_uid": 4
}

UpdateProductsInWishlistOutput

Description

(BETA) Contains the customer's wish list and any errors encountered.

Fields
Field Name Description
user_errors - [WishListUserInputError]! (BETA) An array of errors encountered while updating products in a wish list.
wishlist - Wishlist! (BETA) Contains the wish list with all items that were successfully updated.
Example
{
  "user_errors": [WishListUserInputError],
  "wishlist": Wishlist
}

UpdatePurchaseOrderApprovalRuleInput

Description

(BETA) Defines the changes to be made to an approval rule.

Fields
Input Field Description
applies_to - [ID]

(BETA) An updated list of company user role IDs to which this purchase order approval rule should be applied. When an empty array is provided, the rule is applied to all user roles in the system, including those created in the future.

approvers - [ID]

(BETA) An updated list of B2B user roles that can approve this purchase order approval rule.

condition - CreatePurchaseOrderApprovalRuleConditionInput

(BETA) The updated condition of the purchase order approval rule.

description - String

(BETA) The updated approval rule description.

name - String

(BETA) The updated approval rule name.

status - PurchaseOrderApprovalRuleStatus

(BETA) The updated status of the purchase order approval rule.

uid - ID!

(BETA) Unique identifier for the purchase order approval rule.

Example
{
  "applies_to": ["4"],
  "approvers": [4],
  "condition": CreatePurchaseOrderApprovalRuleConditionInput,
  "description": "xyz789",
  "name": "abc123",
  "status": "ENABLED",
  "uid": 4
}

UpdateRequisitionListInput

Description

(BETA) An input object that defines which requistion list characteristics to update.

Fields
Input Field Description
description - String

(BETA) The updated description of the requisition list.

name - String!

(BETA) The new name of the requisition list.

Example
{
  "description": "xyz789",
  "name": "xyz789"
}

UpdateRequisitionListItemsInput

Description

(BETA) Defines which items in a requisition list to update.

Fields
Input Field Description
entered_options - [EnteredOptionInput]

(BETA) An array of customer-entered options.

item_id - ID!

(BETA) The ID of the requisition list item to update.

quantity - Float

(BETA) The new quantity of the item.

selected_options - [String]

(BETA) An array of selected option IDs.

Example
{
  "entered_options": [EnteredOptionInput],
  "item_id": "4",
  "quantity": 123.45,
  "selected_options": ["xyz789"]
}

UpdateRequisitionListItemsOutput

Description

(BETA) Output of the request to update items in the specified requisition list.

Fields
Field Name Description
requisition_list - RequisitionList (BETA) The requisition list after updating items.
Example
{"requisition_list": RequisitionList}

UpdateRequisitionListOutput

Description

(BETA) Output of the request to rename the requisition list.

Fields
Field Name Description
requisition_list - RequisitionList (BETA) The renamed requisition list.
Example
{"requisition_list": RequisitionList}

UpdateWishlistOutput

Description

(BETA) Contains the name and visibility of an updated wish list.

Fields
Field Name Description
name - String! (BETA) The wish list name.
uid - ID! (BETA) The unique ID of a Wishlist object.
visibility - WishlistVisibilityEnum! (BETA) Indicates whether the wish list is public or private.
Example
{
  "name": "abc123",
  "uid": 4,
  "visibility": "PUBLIC"
}

UrlRewrite

Description

(BETA) Contains URL rewrite details.

Fields
Field Name Description
parameters - [HttpQueryParameter] (BETA) An array of request parameters.
url - String (BETA) The request URL.
Example
{
  "parameters": [HttpQueryParameter],
  "url": "abc123"
}

UrlRewriteEntityTypeEnum

Description

(BETA) This enumeration defines the entity type.

Values
Enum Value Description

CMS_PAGE

PRODUCT

CATEGORY

Example
"CMS_PAGE"

UseInLayeredNavigationOptions

Description

(BETA) Defines whether the attribute is filterable in layered navigation.

Values
Enum Value Description

NO

FILTERABLE_WITH_RESULTS

FILTERABLE_NO_RESULT

Example
"NO"

ValidatePurchaseOrderError

Description

(BETA) Contains details about a failed validation attempt.

Fields
Field Name Description
message - String! (BETA) The returned error message.
type - ValidatePurchaseOrderErrorType! (BETA) Error type.
Example
{"message": "xyz789", "type": "NOT_FOUND"}

ValidatePurchaseOrderErrorType

Values
Enum Value Description

NOT_FOUND

OPERATION_NOT_APPLICABLE

COULD_NOT_SAVE

NOT_VALID_DATA

UNDEFINED

Example
"NOT_FOUND"

ValidatePurchaseOrdersInput

Description

(BETA) Defines the purchase orders to be validated.

Fields
Input Field Description
purchase_order_uids - [ID]!

(BETA) An array of the purchase order IDs.

Example
{"purchase_order_uids": [4]}

ValidatePurchaseOrdersOutput

Description

(BETA) Contains the results of validation attempts.

Fields
Field Name Description
errors - [ValidatePurchaseOrderError]! (BETA) An array of error messages encountered while performing the operation.
purchase_orders - [PurchaseOrder]! (BETA) An array of the purchase orders in the request.
Example
{
  "errors": [ValidatePurchaseOrderError],
  "purchase_orders": [PurchaseOrder]
}

VaultTokenInput

Description

(BETA) Contains required input for payment methods with Vault support.

Fields
Input Field Description
public_hash - String!

(BETA) The public hash of the payment token.

Example
{"public_hash": "abc123"}

VirtualCartItem

Description

(BETA) An implementation for virtual product cart items.

Fields
Field Name Description
customizable_options - [SelectedCustomizableOption]! (BETA) An array containing customizable options the shopper selected.
errors - [CartItemError] (BETA) An array of errors encountered while loading the cart item
id - String! Use uid instead.
prices - CartItemPrices (BETA) Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! (BETA) Details about an item in the cart.
quantity - Float! (BETA) The quantity of this item in the cart.
uid - ID! (BETA) The unique ID for a CartItemInterface object.
Example
{
  "customizable_options": [SelectedCustomizableOption],
  "errors": [CartItemError],
  "id": "xyz789",
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 987.65,
  "uid": "4"
}

VirtualProduct

Description

(BETA) Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.

Fields
Field Name Description
activity - String Use the custom_attributes field instead.
attribute_set_id - Int (BETA) The attribute set assigned to the product. The field should not be used on the storefront.
canonical_url - String (BETA) The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] (BETA) The categories assigned to a product.
category_gear - String Use the custom_attributes field instead.
climate - String Use the custom_attributes field instead.
collar - String Use the custom_attributes field instead.
color - Int Use the custom_attributes field instead.
country_of_manufacture - String (BETA) The product's country of origin.
created_at - String (BETA) Timestamp indicating when the product was created. The field should not be used on the storefront.
crosssell_products - [ProductInterface] (BETA) An array of cross-sell products.
description - ComplexTextValue (BETA) Detailed information about the product. The value can include simple HTML tags.
eco_collection - Int Use the custom_attributes field instead.
erin_recommends - Int Use the custom_attributes field instead.
features_bags - String Use the custom_attributes field instead.
format - Int Use the custom_attributes field instead.
gender - String Use the custom_attributes field instead.
gift_message_available - String (BETA) Indicates whether a gift message is available.
id - Int (BETA) The ID number assigned to the product. Use the uid field instead.
image - ProductImage (BETA) The relative path to the main image on the product page.
is_returnable - String (BETA) Indicates whether the product can be returned.
manufacturer - Int (BETA) A number representing the product's manufacturer. Use the custom_attributes field instead.
material - String Use the custom_attributes field instead.
media_gallery - [MediaGalleryInterface] (BETA) An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] (BETA) An array of MediaGalleryEntry objects. Use media_gallery instead.
meta_description - String (BETA) A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String (BETA) A comma-separated list of keywords that are visible only to search engines.
meta_title - String (BETA) A string that is displayed in the title bar and tab of the browser and in search results lists.
name - String (BETA) The product name. Customers use this name to identify the product.
new - Int Use the custom_attributes field instead.
new_from_date - String (BETA) The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String (BETA) The end date for new product listings.
only_x_left_in_stock - Float (BETA) Product stock only x left count
options - [CustomizableOptionInterface] (BETA) An array of options for a customizable product.
options_container - String (BETA) If the product has multiple options, determines where they appear on the product page.
pattern - String Use the custom_attributes field instead.
performance_fabric - Int Use the custom_attributes field instead.
price - ProductPrices (BETA) Indicates the price of an item. Use price_range for product price information.
price_range - PriceRange! (BETA) The range of prices for the product
price_tiers - [TierPrice] (BETA) An array of TierPrice objects.
product_links - [ProductLinksInterface] (BETA) An array of ProductLinks objects.
purpose - Int Use the custom_attributes field instead.
rating_summary - Float! (BETA) The average of all the ratings given to the product.
redirect_code - Int! (BETA) Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] (BETA) An array of related products.
relative_url - String (BETA) The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! (BETA) The total count of all the reviews given to the product.
reviews - ProductReviews! (BETA) The list of products reviews.
Arguments
pageSize - Int

(BETA) The maximum number of results to return at once. The default is 20.

currentPage - Int

(BETA) The page of results to return. The default is 1.

sale - Int Use the custom_attributes field instead.
short_description - ComplexTextValue (BETA) A short description of the product. Its use depends on the theme.
size - Int Use the custom_attributes field instead.
sku - String (BETA) A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String Use the custom_attributes field instead.
small_image - ProductImage (BETA) The relative path to the small image, which is used on catalog pages.
special_from_date - String (BETA) The beginning date that a product has a special price. The field should not be used on the storefront.
special_price - Float (BETA) The discounted price of the product.
special_to_date - String (BETA) The end date for a product with a special price.
staged - Boolean! (BETA) Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus (BETA) Stock status of the product
strap_bags - String Use the custom_attributes field instead.
style_bags - String Use the custom_attributes field instead.
style_bottom - String Use the custom_attributes field instead.
style_general - String Use the custom_attributes field instead.
swatch_image - String (BETA) The file name of a swatch image.
thumbnail - ProductImage (BETA) The relative path to the product's thumbnail image.
tier_price - Float (BETA) The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information.
tier_prices - [ProductTierPrices] (BETA) An array of ProductTierPrices objects. Use price_tiers for product tier price information.
type - UrlRewriteEntityTypeEnum (BETA) One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String (BETA) One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead.
uid - ID! (BETA) The unique ID for a ProductInterface object.
updated_at - String (BETA) Timestamp indicating when the product was updated. The field should not be used on the storefront.
upsell_products - [ProductInterface] (BETA) An array of up-sell products.
url_key - String (BETA) The part of the URL that identifies the product
url_path - String Use product's canonical_url or url rewrites instead
url_rewrites - [UrlRewrite] (BETA) URL rewrites list
url_suffix - String (BETA) The part of the product URL that is appended after the url key
websites - [Website] (BETA) An array of websites in which the product is available. The field should not be used on the storefront.
Example
{
  "activity": "abc123",
  "attribute_set_id": 123,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "category_gear": "abc123",
  "climate": "xyz789",
  "collar": "xyz789",
  "color": 987,
  "country_of_manufacture": "abc123",
  "created_at": "abc123",
  "crosssell_products": [ProductInterface],
  "description": ComplexTextValue,
  "eco_collection": 123,
  "erin_recommends": 123,
  "features_bags": "abc123",
  "format": 987,
  "gender": "xyz789",
  "gift_message_available": "abc123",
  "id": 987,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "manufacturer": 123,
  "material": "abc123",
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "abc123",
  "meta_keyword": "xyz789",
  "meta_title": "xyz789",
  "name": "xyz789",
  "new": 987,
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 987.65,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "pattern": "xyz789",
  "performance_fabric": 123,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 987,
  "rating_summary": 987.65,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "abc123",
  "review_count": 123,
  "reviews": ProductReviews,
  "sale": 123,
  "short_description": ComplexTextValue,
  "size": 123,
  "sku": "abc123",
  "sleeve": "abc123",
  "small_image": ProductImage,
  "special_from_date": "xyz789",
  "special_price": 987.65,
  "special_to_date": "abc123",
  "staged": true,
  "stock_status": "IN_STOCK",
  "strap_bags": "xyz789",
  "style_bags": "abc123",
  "style_bottom": "xyz789",
  "style_general": "abc123",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "abc123",
  "uid": "4",
  "updated_at": "abc123",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website]
}

VirtualProductCartItemInput

Description

(BETA) Defines a single product to add to the cart.

Fields
Input Field Description
customizable_options - [CustomizableOptionInput]

(BETA) An array that defines customizable options for the product.

data - CartItemInput!

(BETA) An object containing the sku, quantity, and other relevant information about the product.

Example
{
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput
}

VirtualRequisitionListItem

Description

(BETA) Contains details about virtual products added to a requisition list.

Fields
Field Name Description
customizable_options - [SelectedCustomizableOption]! (BETA) Selected custom options for an item in the requisition list.
product - ProductInterface! (BETA) Details about a requisition list item.
quantity - Float! (BETA) The amount added.
uid - ID! (BETA) The unique ID for the requisition list item.
Example
{
  "customizable_options": [SelectedCustomizableOption],
  "product": ProductInterface,
  "quantity": 987.65,
  "uid": 4
}

VirtualWishlistItem

Description

(BETA) Contains a virtual product wish list item.

Fields
Field Name Description
added_at - String! (BETA) The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]! (BETA) Custom options selected for the wish list item.
description - String (BETA) The description of the item.
id - ID! (BETA) The unique ID for a WishlistItemInterface object.
product - ProductInterface (BETA) Product details of the wish list item.
quantity - Float! (BETA) The quantity of this wish list item.
Example
{
  "added_at": "xyz789",
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "id": "4",
  "product": ProductInterface,
  "quantity": 987.65
}

Website

Description

(BETA) Deprecated. It should not be used on the storefront. Contains information about a website.

Fields
Field Name Description
code - String (BETA) A code assigned to the website to identify it. The field should not be used on the storefront.
default_group_id - String (BETA) The default group ID of the website. The field should not be used on the storefront.
id - Int (BETA) The ID number assigned to the website. The field should not be used on the storefront.
is_default - Boolean (BETA) Indicates whether this is the default website. The field should not be used on the storefront.
name - String (BETA) The website name. Websites use this name to identify it easier. The field should not be used on the storefront.
sort_order - Int (BETA) The attribute to use for sorting websites. The field should not be used on the storefront.
Example
{
  "code": "xyz789",
  "default_group_id": "xyz789",
  "id": 987,
  "is_default": true,
  "name": "abc123",
  "sort_order": 123
}

WishListUserInputError

Description

(BETA) An error encountered while performing operations with WishList.

Fields
Field Name Description
code - WishListUserInputErrorType! (BETA) A wish list-specific error code.
message - String! (BETA) A localized error message.
Example
{
  "code": "PRODUCT_NOT_FOUND",
  "message": "abc123"
}

WishListUserInputErrorType

Description

(BETA) A list of possible error types.

Values
Enum Value Description

PRODUCT_NOT_FOUND

UNDEFINED

Example
"PRODUCT_NOT_FOUND"

Wishlist

Description

(BETA) Contains a customer wish list.

Fields
Field Name Description
id - ID (BETA) The unique ID for a Wishlist object.
items - [WishlistItem] Use the items_v2 field instead.
items_count - Int (BETA) The number of items in the wish list.
items_v2 - WishlistItems (BETA) An array of items in the customer's wish list.
Arguments
currentPage - Int
pageSize - Int
name - String (BETA) The name of the wish list.
sharing_code - String (BETA) An encrypted code that Magento uses to link to the wish list.
updated_at - String (BETA) The time of the last modification to the wish list.
visibility - WishlistVisibilityEnum! (BETA) Indicates whether the wish list is public or private.
Example
{
  "id": 4,
  "items": [WishlistItem],
  "items_count": 123,
  "items_v2": WishlistItems,
  "name": "abc123",
  "sharing_code": "abc123",
  "updated_at": "abc123",
  "visibility": "PUBLIC"
}

WishlistCartUserInputError

Description

(BETA) Contains details about errors encountered when a customer added wish list items to the cart.

Fields
Field Name Description
code - WishlistCartUserInputErrorType! (BETA) An error code that describes the error encountered.
message - String! (BETA) A localized error message.
wishlistId - ID! (BETA) The unique ID of the Wishlist object containing an error.
wishlistItemId - ID! (BETA) The unique ID of the wish list item containing an error.
Example
{
  "code": "PRODUCT_NOT_FOUND",
  "message": "abc123",
  "wishlistId": "4",
  "wishlistItemId": 4
}

WishlistCartUserInputErrorType

Description

(BETA) A list of possible error types.

Values
Enum Value Description

PRODUCT_NOT_FOUND

NOT_SALABLE

INSUFFICIENT_STOCK

UNDEFINED

Example
"PRODUCT_NOT_FOUND"

WishlistItem

Description

(BETA) Contains details about a wish list item.

Fields
Field Name Description
added_at - String (BETA) The time when the customer added the item to the wish list.
description - String (BETA) The customer's comment about this item.
id - Int (BETA) The unique ID for a WishlistItem object.
product - ProductInterface (BETA) Details about the wish list item.
qty - Float (BETA) The quantity of this wish list item
Example
{
  "added_at": "abc123",
  "description": "abc123",
  "id": 123,
  "product": ProductInterface,
  "qty": 123.45
}

WishlistItemCopyInput

Description

(BETA) Specifies the IDs of items to copy and their quantities.

Fields
Input Field Description
quantity - Float

(BETA) The quantity of this item to copy to the destination wish list. This value can't be greater than the quantity in the source wish list.

wishlist_item_id - ID!

(BETA) The unique ID of the WishlistItemInterface object to be copied.

Example
{
  "quantity": 987.65,
  "wishlist_item_id": "4"
}

WishlistItemInput

Description

(BETA) Defines the items to add to a wish list.

Fields
Input Field Description
entered_options - [EnteredOptionInput]

(BETA) An array of options that the customer entered.

parent_sku - String

(BETA) For complex product types, the SKU of the parent product.

quantity - Float!

(BETA) The amount or number of items to add.

selected_options - [ID]

(BETA) An array of strings corresponding to options the customer selected.

sku - String!

(BETA) The SKU of the product to add. For complex product types, specify the child product SKU.

Example
{
  "entered_options": [EnteredOptionInput],
  "parent_sku": "xyz789",
  "quantity": 123.45,
  "selected_options": [4],
  "sku": "abc123"
}

WishlistItemInterface

Description

(BETA) The interface for wish list items.

Fields
Field Name Description
added_at - String! (BETA) The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]! (BETA) Custom options selected for the wish list item.
description - String (BETA) The description of the item.
id - ID! (BETA) The unique ID for a WishlistItemInterface object.
product - ProductInterface (BETA) Product details of the wish list item.
quantity - Float! (BETA) The quantity of this wish list item.
Example
{
  "added_at": "xyz789",
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "id": "4",
  "product": ProductInterface,
  "quantity": 123.45
}

WishlistItemMoveInput

Description

(BETA) Specifies the IDs of the items to move and their quantities.

Fields
Input Field Description
quantity - Float

(BETA) The quantity of this item to move to the destination wish list. This value can't be greater than the quantity in the source wish list.

wishlist_item_id - ID!

(BETA) The unique ID of the WishlistItemInterface object to be moved.

Example
{
  "quantity": 123.45,
  "wishlist_item_id": "4"
}

WishlistItemUpdateInput

Description

(BETA) Defines updates to items in a wish list.

Fields
Input Field Description
description - String

(BETA) Customer-entered comments about the item.

entered_options - [EnteredOptionInput]

(BETA) An array of options that the customer entered.

quantity - Float

(BETA) The new amount or number of this item.

selected_options - [ID]

(BETA) An array of strings corresponding to options the customer selected.

wishlist_item_id - ID!

(BETA) The unique ID for a WishlistItemInterface object.

Example
{
  "description": "abc123",
  "entered_options": [EnteredOptionInput],
  "quantity": 123.45,
  "selected_options": ["4"],
  "wishlist_item_id": "4"
}

WishlistItems

Description

(BETA) Contains an array of items in a wish list.

Fields
Field Name Description
items - [WishlistItemInterface]! (BETA) A list of items in the wish list.
page_info - SearchResultPageInfo (BETA) Contains pagination metadata.
Example
{
  "items": [WishlistItemInterface],
  "page_info": SearchResultPageInfo
}

WishlistOutput

Description

(BETA) Deprecated: Use the Wishlist type instead.

Fields
Field Name Description
items - [WishlistItem] (BETA) An array of items in the customer's wish list Use the Wishlist.items field instead.
items_count - Int (BETA) The number of items in the wish list. Use the Wishlist.items_count field instead.
name - String (BETA) When multiple wish lists are enabled, the name the customer assigns to the wishlist. This field is related to Commerce functionality and is always null in Open Source.
sharing_code - String (BETA) An encrypted code that links to the wish list. Use the Wishlist.sharing_code field instead.
updated_at - String (BETA) The time of the last modification to the wish list. Use the Wishlist.updated_at field instead.
Example
{
  "items": [WishlistItem],
  "items_count": 123,
  "name": "abc123",
  "sharing_code": "xyz789",
  "updated_at": "xyz789"
}

WishlistVisibilityEnum

Description

(BETA) Defines the wish list visibility types.

Values
Enum Value Description

PUBLIC

PRIVATE

Example
"PUBLIC"

createEmptyCartInput

Description

(BETA) Assigns a specific cart_id to the empty cart.

Fields
Input Field Description
cart_id - String

(BETA) The ID to assign to the cart.

Example
{"cart_id": "xyz789"}